swagger.json in purecloud-0.25.0 vs swagger.json in purecloud-0.26.0

@@ -1 +1 @@
-{"swagger":"2.0","info":{"description":"PureCloud API","version":"v1","title":"PureCloud API","termsOfService":"http://www.inin.com","contact":{"name":"Chuck Pulfer","url":"http://www.inin.com","email":"[e-mail]"},"license":{"name":"ININ","url":"http://www.inin.com"}},"host":"api.mypurecloud.com","tags":[{"name":"Architect","description":"Prompts, IVR, schedules, voice xml, dependency tracking.","externalDocs":{"description":"architect docs","url":"https://developer.mypurecloud.com/architect"}},{"name":"Attributes","description":"Attribute definitions"},{"name":"Authorization","description":"Roles and permissions","externalDocs":{"description":"authorization docs","url":"https://developer.mypurecloud.com/authorization"}},{"name":"Compliance","description":""},{"name":"Configuration","description":""},{"name":"Content Management","description":""},{"name":"Conversations","description":""},{"name":"Docs","description":"Swagger documentation definitions","externalDocs":{"description":"docs","url":"https://developer.mypurecloud.com"}},{"name":"Downloads","description":"Download file"},{"name":"Evaluations","description":""},{"name":"External Contacts","description":"External Organizations, contacts, notes and relationships"},{"name":"Fax","description":""},{"name":"Geolocation","description":""},{"name":"Greetings","description":""},{"name":"Groups","description":"Groups, members"},{"name":"Languages","description":"Available languages"},{"name":"Licensing","description":""},{"name":"Locations","description":"Physical locations"},{"name":"Notifications","description":"Channels, subscriptions, topics"},{"name":"OAuth","description":"OAuth clients, providers"},{"name":"Outbound","description":""},{"name":"Presence","description":"User and organization presences"},{"name":"Quality","description":"Evaluations, calibrations"},{"name":"Recording","description":"Recordings, policies, annotations, orphans"},{"name":"Response Management","description":"Responses, library, query"},{"name":"Routing","description":"Queues, wrapup codes, skills, email config"},{"name":"Scripts","description":"Composer"},{"name":"Search","description":"Chat search"},{"name":"Stations","description":"Stations"},{"name":"Telephony Providers Edge","description":"Edge phones, trunks, lines.","externalDocs":{"description":"telephony provider edge","url":"https://developer.mypurecloud.com/telephonyprovideredge"}},{"name":"Tokens","description":"Authentication Tokens"},{"name":"User Recordings","description":"Summary, media"},{"name":"Users","description":"Me, routing, roles"},{"name":"Utilities","description":""},{"name":"Voicemail","description":"Mailbox, messages, policy"}],"schemes":["https"],"consumes":["application/json"],"produces":["application/json"],"paths":{"/api/v1/architect/audits":{"post":{"tags":["Architect"],"summary":"Gets architect-data-service audit entries.","description":"","operationId":"postAudits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"AuditSearchRequest","required":false,"schema":{"$ref":"#/definitions/CommonAuditRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditSearchResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postAudits"}},"/api/v1/architect/ivrs":{"get":{"tags":["Architect"],"summary":"Get IVR configs.","description":"","operationId":"getIvrs","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVREntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getIvrs"},"post":{"tags":["Architect"],"summary":"Create IVR config.","description":"","operationId":"postIvrs","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/IVR"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVR"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postIvrs"}},"/api/v1/architect/ivrs/actions/publish":{"post":{"tags":["Architect"],"summary":"Publish an IVR config.","description":"","operationId":"postIvrsActionsPublish","produces":["application/json"],"parameters":[{"name":"id","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVR"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postIvrsActionsPublish"}},"/api/v1/architect/ivrs/{ivrId}":{"get":{"tags":["Architect"],"summary":"Get an IVR config.","description":"","operationId":"getIvrsIvrId","produces":["application/json"],"parameters":[{"name":"ivrId","in":"path","description":"IVR id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVR"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getIvrsIvrId"},"put":{"tags":["Architect"],"summary":"Update an IVR Config.","description":"","operationId":"putIvrsIvrId","produces":["application/json"],"parameters":[{"name":"ivrId","in":"path","description":"IVR id","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/IVR"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVR"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putIvrsIvrId"},"delete":{"tags":["Architect"],"summary":"Delete an IVR Config.","description":"","operationId":"deleteIvrsIvrId","produces":["application/json"],"parameters":[{"name":"ivrId","in":"path","description":"IVR id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteIvrsIvrId"}},"/api/v1/architect/prompts":{"get":{"tags":["Architect"],"summary":"Get a pageable list of user prompts","description":"The returned list is pageable, and query parameters can be used for filtering.  Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated.","operationId":"getPrompts","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPrompts"},"post":{"tags":["Architect"],"summary":"Create a new user prompt","description":"","operationId":"postPrompts","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Prompt"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Prompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postPrompts"},"delete":{"tags":["Architect"],"summary":"Batch-delete a list of prompts","description":"Multiple IDs can be specified, in which case all specified prompts will be deleted.","operationId":"deletePrompts","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"List of Prompt IDs","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"ignoreDependencies","in":"query","description":"Ignore Dependencies","required":false,"type":"boolean","default":false}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deletePrompts"}},"/api/v1/architect/prompts/{promptId}":{"get":{"tags":["Architect"],"summary":"Get specified user prompt","description":"","operationId":"getPromptsPromptId","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Prompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPromptsPromptId"},"put":{"tags":["Architect"],"summary":"Update specified user prompt","description":"","operationId":"putPromptsPromptId","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Prompt"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Prompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putPromptsPromptId"},"delete":{"tags":["Architect"],"summary":"Delete specified user prompt","description":"","operationId":"deletePromptsPromptId","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deletePromptsPromptId"}},"/api/v1/architect/prompts/{promptId}/resources":{"get":{"tags":["Architect"],"summary":"Get a pageable list of user prompt resources","description":"The returned list is pageable, and query paramaters can be used for filtering.","operationId":"getPromptsPromptIdResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAssetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPromptsPromptIdResources"},"post":{"tags":["Architect"],"summary":"Create a new user prompt resource.","description":"","operationId":"postPromptsPromptIdResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PromptAsset"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postPromptsPromptIdResources"}},"/api/v1/architect/prompts/{promptId}/resources/{language}":{"get":{"tags":["Architect"],"summary":"Get specified user prompt resource","description":"","operationId":"getPromptsPromptIdResourcesLanguage","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"language","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPromptsPromptIdResourcesLanguage"},"put":{"tags":["Architect"],"summary":"Update specified user prompt resource","description":"","operationId":"putPromptsPromptIdResourcesLanguage","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"language","in":"path","description":"Language","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PromptAsset"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putPromptsPromptIdResourcesLanguage"},"delete":{"tags":["Architect"],"summary":"Delete specified user prompt resource","description":"","operationId":"deletePromptsPromptIdResourcesLanguage","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"language","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deletePromptsPromptIdResourcesLanguage"}},"/api/v1/architect/schedulegroups":{"get":{"tags":["Architect"],"summary":"Get a list of schedule groups.","description":"","operationId":"getSchedulegroups","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchedulegroups"},"post":{"tags":["Architect"],"summary":"Creates a new schedule group","description":"","operationId":"postSchedulegroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ScheduleGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSchedulegroups"}},"/api/v1/architect/schedulegroups/{scheduleGroupId}":{"get":{"tags":["Architect"],"summary":"Gets a schedule group by ID","description":"","operationId":"getSchedulegroupsSchedulegroupId","produces":["application/json"],"parameters":[{"name":"scheduleGroupId","in":"path","description":"Schedule group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchedulegroupsSchedulegroupId"},"put":{"tags":["Architect"],"summary":"Updates a schedule group by ID","description":"","operationId":"putSchedulegroupsSchedulegroupId","produces":["application/json"],"parameters":[{"name":"scheduleGroupId","in":"path","description":"Schedule group ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ScheduleGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSchedulegroupsSchedulegroupId"},"delete":{"tags":["Architect"],"summary":"Deletes a schedule group by ID","description":"","operationId":"deleteSchedulegroupsSchedulegroupId","produces":["application/json"],"parameters":[{"name":"scheduleGroupId","in":"path","description":"Schedule group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSchedulegroupsSchedulegroupId"}},"/api/v1/architect/schedules":{"get":{"tags":["Architect"],"summary":"Get a list of schedules.","description":"","operationId":"getSchedules","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchedules"},"post":{"tags":["Architect"],"summary":"Create a new schedule.","description":"","operationId":"postSchedules","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Schedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Schedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSchedules"}},"/api/v1/architect/schedules/{scheduleId}":{"get":{"tags":["Architect"],"summary":"Get a schedule by ID","description":"","operationId":"getSchedulesScheduleId","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Schedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchedulesScheduleId"},"put":{"tags":["Architect"],"summary":"Update schedule by ID","description":"","operationId":"putSchedulesScheduleId","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Schedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Schedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSchedulesScheduleId"},"delete":{"tags":["Architect"],"summary":"Delete a schedule by id","description":"","operationId":"deleteSchedulesScheduleId","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSchedulesScheduleId"}},"/api/v1/architect/systemprompts":{"get":{"tags":["Architect"],"summary":"Get System Prompts.","description":"","operationId":"getSystemprompts","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSystemprompts"}},"/api/v1/architect/systemprompts/{promptId}":{"get":{"tags":["Architect"],"summary":"Get IVR system prompt.","description":"","operationId":"getSystempromptsPromptId","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPrompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSystempromptsPromptId"}},"/api/v1/architect/systemprompts/{promptId}/resources":{"get":{"tags":["Architect"],"summary":"Get IVR System Prompt resources.","description":"","operationId":"getSystempromptsPromptIdResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAssetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSystempromptsPromptIdResources"},"post":{"tags":["Architect"],"summary":"Create system prompt resource override.","description":"","operationId":"postSystempromptsPromptIdResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SystemPromptAsset"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSystempromptsPromptIdResources"}},"/api/v1/architect/systemprompts/{promptId}/resources/{language}":{"get":{"tags":["Architect"],"summary":"Get a system prompt resource.","description":"","operationId":"getSystempromptsPromptIdResourcesLanguage","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"language","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSystempromptsPromptIdResourcesLanguage"},"delete":{"tags":["Architect"],"summary":"Delete a system prompt resource override.","description":"","operationId":"deleteSystempromptsPromptIdResourcesLanguage","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"language","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSystempromptsPromptIdResourcesLanguage"}},"/api/v1/attributes":{"get":{"tags":["Attributes"],"summary":"Gets a list of existing attributes.","description":"","operationId":"getAttributes","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttributeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getAttributes"},"post":{"tags":["Attributes"],"summary":"Create an attribute.","description":"","operationId":"postAttributes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Attribute","required":false,"schema":{"$ref":"#/definitions/Attribute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Attribute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postAttributes"}},"/api/v1/attributes/query":{"post":{"tags":["Attributes"],"summary":"Query attributes","description":"","operationId":"postQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":false,"schema":{"$ref":"#/definitions/AttributeQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttributeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQuery"}},"/api/v1/attributes/{attributeId}":{"get":{"tags":["Attributes"],"summary":"Get details about an existing attribute.","description":"","operationId":"getAttributeId","produces":["application/json"],"parameters":[{"name":"attributeId","in":"path","description":"Attribute ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Attribute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getAttributeId"},"put":{"tags":["Attributes"],"summary":"Update an existing attribute.","description":"Fields that can be updated: name, description. The most recent version is required for updates.","operationId":"putAttributeId","produces":["application/json"],"parameters":[{"name":"attributeId","in":"path","description":"Attribute ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Attribute","required":false,"schema":{"$ref":"#/definitions/Attribute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Attribute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"409":{"description":"Resource conflict - Unexpected version was provided"},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putAttributeId"},"delete":{"tags":["Attributes"],"summary":"Delete an existing Attribute.","description":"This will remove attribute.","operationId":"deleteAttributeId","produces":["application/json"],"parameters":[{"name":"attributeId","in":"path","description":"Attribute ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteAttributeId"}},"/api/v1/authorization/licenses":{"get":{"tags":["Authorization"],"summary":"Retrieve a list of all licenses defined in the system","description":"","operationId":"getLicenses","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLicenseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLicenses"}},"/api/v1/authorization/permissions":{"get":{"tags":["Authorization"],"summary":"Get all permissions.","description":"Retrieve a list of all permission defined in the system.","operationId":"getPermissions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PermissionCollectionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPermissions"}},"/api/v1/authorization/products":{"get":{"tags":["Authorization"],"summary":"Get the list of enabled products","description":"Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.","operationId":"getProducts","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationProductEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProducts"}},"/api/v1/authorization/roles":{"get":{"tags":["Authorization"],"summary":"Retrieve a list of all roles defined for the organization","description":"","operationId":"getRoles","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"permission","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"userCount","in":"query","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRoles"},"post":{"tags":["Authorization"],"summary":"Create an organization role.","description":"","operationId":"postRoles","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DomainOrganizationRole"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRoles"}},"/api/v1/authorization/roles/default":{"post":{"tags":["Authorization"],"summary":"Restores all default roles","description":"This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles.","operationId":"postRolesDefault","produces":["application/json"],"parameters":[{"name":"force","in":"query","description":"Restore default roles","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRolesDefault"},"put":{"tags":["Authorization"],"summary":"Restore specified default roles","description":"","operationId":"putRolesDefault","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationRole"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRolesDefault"}},"/api/v1/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}":{"get":{"tags":["Authorization"],"summary":"Get an org role to default role comparison comparison","description":"Compares any organization role to a default role id and show differences","operationId":"getRolesLeftroleIdComparedefaultRightroleId","produces":["application/json"],"parameters":[{"name":"leftRoleId","in":"path","description":"Left Role ID","required":true,"type":"string"},{"name":"rightRoleId","in":"path","description":"Right Role id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrgRoleDifference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRolesLeftroleIdComparedefaultRightroleId"},"post":{"tags":["Authorization"],"summary":" Get an unsaved org role to default role comparison","description":"Allows users to compare their existing roles in an unsaved state to its default role","operationId":"postRolesLeftroleIdComparedefaultRightroleId","produces":["application/json"],"parameters":[{"name":"leftRoleId","in":"path","description":"Left Role ID","required":true,"type":"string"},{"name":"rightRoleId","in":"path","description":"Right Role id","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DomainOrganizationRole"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrgRoleDifference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRolesLeftroleIdComparedefaultRightroleId"}},"/api/v1/authorization/roles/{roleId}":{"get":{"tags":["Authorization"],"summary":"Get a single organization role.","description":"Get the organization role specified by its ID.","operationId":"getRolesRoleId","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRolesRoleId"},"put":{"tags":["Authorization"],"summary":"Update an organization role.","description":"Update","operationId":"putRolesRoleId","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DomainOrganizationRole"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRolesRoleId"},"delete":{"tags":["Authorization"],"summary":"Delete an organization role.","description":"","operationId":"deleteRolesRoleId","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteRolesRoleId"},"patch":{"tags":["Authorization"],"summary":"Patch Organization Role for needsUpdate Field","description":"Patch Organization Role for needsUpdate Field","operationId":"patchRolesRoleId","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DomainOrganizationRole"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchRolesRoleId"}},"/api/v1/authorization/roles/{roleId}/users/add":{"put":{"tags":["Authorization"],"summary":"Sets the users for the role","description":"","operationId":"putRolesRoleIdUsersAdd","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRolesRoleIdUsersAdd"}},"/api/v1/authorization/roles/{roleId}/users/remove":{"put":{"tags":["Authorization"],"summary":"Removes the users from the role","description":"","operationId":"putRolesRoleIdUsersRemove","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRolesRoleIdUsersRemove"}},"/api/v1/authorization/users/{userId}/roles":{"get":{"tags":["Authorization"],"summary":"Get the list of roles for a user.","description":"","operationId":"getUsersUserIdRoles","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUsersUserIdRoles"},"put":{"tags":["Authorization"],"summary":"Sets the user's roles","description":"","operationId":"putUsersUserIdRoles","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUsersUserIdRoles"},"delete":{"tags":["Authorization"],"summary":"Removes all the roles from the user.","description":"","operationId":"deleteUsersUserIdRoles","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteUsersUserIdRoles"}},"/api/v1/certificate/details":{"post":{"tags":["Utilities"],"summary":"Returns the information about an X509 PEM encoded certificate or certificate chain.","description":"","operationId":"postDetails","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Certificate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ParsedCertificate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDetails"}},"/api/v1/compliance/hipaa":{"get":{"tags":["Compliance"],"summary":"Get information about HIPAA compliance","description":"","operationId":"getHipaa","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HIPAAConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getHipaa"},"put":{"tags":["Compliance"],"summary":"Update HIPAA compliance options","description":"","operationId":"putHipaa","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/HIPAAConfig"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HIPAAConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putHipaa"}},"/api/v1/configuration/addressvalidation":{"post":{"tags":["Utilities"],"summary":"Validates a street address","description":"","operationId":"postAddressvalidation","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ValidateAddressRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ValidateAddressResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postAddressvalidation"}},"/api/v1/configuration/didpools":{"get":{"tags":["Configuration"],"summary":"Get a listing of DID Pools","description":"","operationId":"getDidpools","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPoolEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDidpools"},"post":{"tags":["Configuration"],"summary":"Create a new DID pool","description":"","operationId":"postDidpools","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DIDPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDidpools"}},"/api/v1/configuration/didpools/{didPoolId}":{"get":{"tags":["Configuration"],"summary":"Get a DID Pool by ID.","description":"","operationId":"getDidpoolsDidpoolId","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDidpoolsDidpoolId"},"put":{"tags":["Configuration"],"summary":"Update a DID Pool by ID.","description":"","operationId":"putDidpoolsDidpoolId","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DIDPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putDidpoolsDidpoolId"},"delete":{"tags":["Configuration"],"summary":"Delete a DID Pool by ID.","description":"","operationId":"deleteDidpoolsDidpoolId","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteDidpoolsDidpoolId"}},"/api/v1/configuration/dids":{"get":{"tags":["Configuration"],"summary":"Get a listing of DIDs","description":"","operationId":"getDids","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"phoneNumber","in":"query","description":"Filter by phoneNumber","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDids"}},"/api/v1/configuration/dids/{didId}":{"get":{"tags":["Configuration"],"summary":"Get a DID by ID.","description":"","operationId":"getDidsDidId","produces":["application/json"],"parameters":[{"name":"didId","in":"path","description":"DID ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DID"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDidsDidId"},"put":{"tags":["Configuration"],"summary":"Update a DID by ID.","description":"","operationId":"putDidsDidId","produces":["application/json"],"parameters":[{"name":"didId","in":"path","description":"DID ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DID"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DID"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putDidsDidId"}},"/api/v1/configuration/edges":{"get":{"tags":["Configuration"],"summary":"Get the list of edges.","description":"","operationId":"getEdges","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"site.id","in":"query","description":"Filter by site.id","required":false,"type":"string"},{"name":"edgeGroup.id","in":"query","description":"Filter by edgeGroup.id","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdges"},"post":{"tags":["Configuration"],"summary":"Create a edge.","description":"","operationId":"postEdges","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Edge","required":false,"schema":{"$ref":"#/definitions/Edge"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEdges"}},"/api/v1/configuration/edges/certificateauthorities":{"get":{"tags":["Configuration"],"summary":"Get the list of certificate authorities.","description":"","operationId":"getEdgesCertificateauthorities","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CertificateAuthorityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesCertificateauthorities"},"post":{"tags":["Configuration"],"summary":"Create a certificate authority.","description":"","operationId":"postEdgesCertificateauthorities","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CertificateAuthority","required":false,"schema":{"$ref":"#/definitions/DomainCertificateAuthority"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEdgesCertificateauthorities"}},"/api/v1/configuration/edges/certificateauthorities/{certificateId}":{"get":{"tags":["Configuration"],"summary":"Get a certificate authority.","description":"","operationId":"getEdgesCertificateauthoritiesCertificateId","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesCertificateauthoritiesCertificateId"},"put":{"tags":["Configuration"],"summary":"Update a certificate authority.","description":"","operationId":"putEdgesCertificateauthoritiesCertificateId","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DomainCertificateAuthority"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putEdgesCertificateauthoritiesCertificateId"},"delete":{"tags":["Configuration"],"summary":"Delete a certificate authority.","description":"","operationId":"deleteEdgesCertificateauthoritiesCertificateId","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteEdgesCertificateauthoritiesCertificateId"}},"/api/v1/configuration/edges/{edgeId}":{"get":{"tags":["Configuration"],"summary":"Get edge.","description":"","operationId":"getEdgesEdgeId","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesEdgeId"},"put":{"tags":["Configuration"],"summary":"Update a edge.","description":"","operationId":"putEdgesEdgeId","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Edge","required":false,"schema":{"$ref":"#/definitions/Edge"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putEdgesEdgeId"},"delete":{"tags":["Configuration"],"summary":"Delete a edge.","description":"","operationId":"deleteEdgesEdgeId","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteEdgesEdgeId"}},"/api/v1/configuration/edges/{edgeId}/lines":{"get":{"tags":["Configuration"],"summary":"Get the list of lines.","description":"","operationId":"getEdgesEdgeIdLines","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeLineEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesEdgeIdLines"}},"/api/v1/configuration/edges/{edgeId}/lines/{lineId}":{"get":{"tags":["Configuration"],"summary":"Get line","description":"","operationId":"getEdgesEdgeIdLinesLineId","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"lineId","in":"path","description":"Line ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeLine"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesEdgeIdLinesLineId"},"put":{"tags":["Configuration"],"summary":"Update a line.","description":"","operationId":"putEdgesEdgeIdLinesLineId","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"lineId","in":"path","description":"Line ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Line","required":false,"schema":{"$ref":"#/definitions/EdgeLine"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeLine"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putEdgesEdgeIdLinesLineId"}},"/api/v1/configuration/edges/{edgeId}/logicalinterfaces":{"get":{"tags":["Configuration"],"summary":"Get edge logical interfaces.","description":"Retrieve a list of all configured logical interfaces from a specific edge.","operationId":"getEdgesEdgeIdLogicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesEdgeIdLogicalinterfaces"},"post":{"tags":["Configuration"],"summary":"Create an edge logical interface.","description":"Create","operationId":"postEdgesEdgeIdLogicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DomainLogicalInterface"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEdgesEdgeIdLogicalinterfaces"}},"/api/v1/configuration/edges/{edgeId}/logicalinterfaces/{interfaceId}":{"get":{"tags":["Configuration"],"summary":"Get an edge logical interface","description":"","operationId":"getEdgesEdgeIdLogicalinterfacesInterfaceId","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesEdgeIdLogicalinterfacesInterfaceId"},"put":{"tags":["Configuration"],"summary":"Update an edge logical interface.","description":"","operationId":"putEdgesEdgeIdLogicalinterfacesInterfaceId","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DomainLogicalInterface"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putEdgesEdgeIdLogicalinterfacesInterfaceId"},"delete":{"tags":["Configuration"],"summary":"Delete an edge logical interface","description":"","operationId":"deleteEdgesEdgeIdLogicalinterfacesInterfaceId","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteEdgesEdgeIdLogicalinterfacesInterfaceId"}},"/api/v1/configuration/edges/{edgeId}/logs/jobs":{"post":{"tags":["Configuration"],"summary":"Create a job to upload a list of Edge logs.","description":"","operationId":"postEdgesEdgeIdLogsJobs","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EdgeLogsJobRequest","required":false,"schema":{"$ref":"#/definitions/EdgeLogsJobRequest"}}],"responses":{"202":{"description":"Accepted - Job is being processed.  The job ID is returned.","schema":{"$ref":"#/definitions/EdgeLogsJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEdgesEdgeIdLogsJobs"}},"/api/v1/configuration/edges/{edgeId}/logs/jobs/{jobId}":{"get":{"tags":["Configuration"],"summary":"Get an Edge logs job.","description":"","operationId":"getEdgesEdgeIdLogsJobsJobId","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"}],"responses":{"200":{"description":"Edge log list has been returned in the response.","schema":{"$ref":"#/definitions/EdgeLogsJob"}},"202":{"description":"Accepted - Processing Edge logs job, try again soon."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesEdgeIdLogsJobsJobId"}},"/api/v1/configuration/edges/{edgeId}/logs/jobs/{jobId}/upload":{"post":{"tags":["Configuration"],"summary":"Request that the specified fileIds be uploaded from the Edge.","description":"","operationId":"postEdgesEdgeIdLogsJobsJobIdUpload","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/EdgeLogsJobUploadRequest"}}],"responses":{"202":{"description":"Accepted - Files are being uploaded to the job.  Watch the uploadStatus property on the job files."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEdgesEdgeIdLogsJobsJobIdUpload"}},"/api/v1/configuration/edges/{edgeId}/physicalinterfaces":{"get":{"tags":["Configuration"],"summary":"Retrieve a list of all configured physical interfaces from a specific edge.","description":"","operationId":"getEdgesEdgeIdPhysicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhysicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesEdgeIdPhysicalinterfaces"}},"/api/v1/configuration/edges/{edgeId}/physicalinterfaces/{interfaceId}":{"get":{"tags":["Configuration"],"summary":"Get edge physical interface.","description":"Retrieve a physical interface from a specific edge.","operationId":"getEdgesEdgeIdPhysicalinterfacesInterfaceId","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainPhysicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesEdgeIdPhysicalinterfacesInterfaceId"}},"/api/v1/configuration/edges/{edgeId}/reboot":{"post":{"tags":["Configuration"],"summary":"Reboot an Edge","description":"","operationId":"postEdgesEdgeIdReboot","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEdgesEdgeIdReboot"}},"/api/v1/configuration/edges/{edgeId}/softwareupdate":{"get":{"tags":["Configuration"],"summary":"Gets software update status information about any edge.","description":"","operationId":"getEdgesEdgeIdSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesEdgeIdSoftwareupdate"},"post":{"tags":["Configuration"],"summary":"Starts a software update for this edge.","description":"","operationId":"postEdgesEdgeIdSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEdgesEdgeIdSoftwareupdate"},"delete":{"tags":["Configuration"],"summary":"Cancels any in-progress update for this edge.","description":"","operationId":"deleteEdgesEdgeIdSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteEdgesEdgeIdSoftwareupdate"}},"/api/v1/configuration/edges/{edgeId}/softwareversions":{"get":{"tags":["Configuration"],"summary":"Gets all the available software versions for this edge.","description":"","operationId":"getEdgesEdgeIdSoftwareversions","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareVersionDto"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesEdgeIdSoftwareversions"}},"/api/v1/configuration/edges/{edgeId}/unpair":{"post":{"tags":["Configuration"],"summary":"Unpair an Edge","description":"","operationId":"postEdgesEdgeIdUnpair","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEdgesEdgeIdUnpair"}},"/api/v1/configuration/edgeversionreport":{"get":{"tags":["Configuration"],"summary":"Get the edge version report.","description":"The report will not have consistent data about the edge version(s) until all edges have been reset.","operationId":"getEdgeversionreport","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeVersionReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgeversionreport"}},"/api/v1/configuration/endpoints":{"get":{"tags":["Configuration"],"summary":"Get endpoints","description":"","operationId":"getEndpoints","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EndpointEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEndpoints"},"post":{"tags":["Configuration"],"summary":"Create endpoint","description":"","operationId":"postEndpoints","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"EndpointTemplate","required":false,"schema":{"$ref":"#/definitions/Endpoint"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Endpoint"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEndpoints"}},"/api/v1/configuration/endpoints/{endpointId}":{"get":{"tags":["Configuration"],"summary":"Get endpoint","description":"","operationId":"getEndpointsEndpointId","produces":["application/json"],"parameters":[{"name":"endpointId","in":"path","description":"Endpoint ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Endpoint"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEndpointsEndpointId"},"put":{"tags":["Configuration"],"summary":"Update endpoint","description":"","operationId":"putEndpointsEndpointId","produces":["application/json"],"parameters":[{"name":"endpointId","in":"path","description":"Endpoint ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EndpointTemplate","required":false,"schema":{"$ref":"#/definitions/Endpoint"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Endpoint"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putEndpointsEndpointId"},"delete":{"tags":["Configuration"],"summary":"Delete endpoint","description":"","operationId":"deleteEndpointsEndpointId","produces":["application/json"],"parameters":[{"name":"endpointId","in":"path","description":"Endpoint ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteEndpointsEndpointId"}},"/api/v1/configuration/extensionpools":{"get":{"tags":["Configuration"],"summary":"Get a listing of extension pools","description":"","operationId":"getExtensionpools","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"startNumber"},{"name":"number","in":"query","description":"Number","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPoolEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getExtensionpools"},"post":{"tags":["Configuration"],"summary":"Create a new extension pool","description":"","operationId":"postExtensionpools","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExtensionPool","required":false,"schema":{"$ref":"#/definitions/ExtensionPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Extension"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postExtensionpools"}},"/api/v1/configuration/extensionpools/{extensionPoolId}":{"get":{"tags":["Configuration"],"summary":"Get an extension pool by ID","description":"","operationId":"getExtensionpoolsExtensionpoolId","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getExtensionpoolsExtensionpoolId"},"put":{"tags":["Configuration"],"summary":"Update an extension pool by ID","description":"","operationId":"putExtensionpoolsExtensionpoolId","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExtensionPool","required":false,"schema":{"$ref":"#/definitions/ExtensionPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putExtensionpoolsExtensionpoolId"},"delete":{"tags":["Configuration"],"summary":"Delete an extension pool by ID","description":"","operationId":"deleteExtensionpoolsExtensionpoolId","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteExtensionpoolsExtensionpoolId"}},"/api/v1/configuration/extensions":{"get":{"tags":["Configuration"],"summary":"Get a listing of extensions","description":"","operationId":"getExtensions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"number","in":"query","description":"Filter by number","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getExtensions"}},"/api/v1/configuration/extensions/{extensionId}":{"get":{"tags":["Configuration"],"summary":"Get an extension by ID.","description":"","operationId":"getExtensionsExtensionId","produces":["application/json"],"parameters":[{"name":"extensionId","in":"path","description":"Extension ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Extension"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getExtensionsExtensionId"},"put":{"tags":["Configuration"],"summary":"Update an extension by ID.","description":"","operationId":"putExtensionsExtensionId","produces":["application/json"],"parameters":[{"name":"extensionId","in":"path","description":"Extension ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Extension"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Extension"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putExtensionsExtensionId"}},"/api/v1/configuration/organization":{"get":{"tags":["Configuration"],"summary":"Get context organization.","description":"","operationId":"getOrganization","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrganization"},"put":{"tags":["Configuration"],"summary":"Update context organization.","description":"","operationId":"putOrganization","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization","required":false,"schema":{"$ref":"#/definitions/Organization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putOrganization"}},"/api/v1/configuration/organizations":{"post":{"tags":["Configuration"],"summary":"Create organization.","description":"","operationId":"postOrganizations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization","required":false,"schema":{"$ref":"#/definitions/OrganizationCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postOrganizations"}},"/api/v1/configuration/organizations/{orgId}":{"get":{"tags":["Configuration"],"summary":"Get organization.","description":"","operationId":"getOrganizationsOrgId","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","description":"Organization ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrganizationsOrgId"},"put":{"tags":["Configuration"],"summary":"Update organization.","description":"","operationId":"putOrganizationsOrgId","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","description":"Organization ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization","required":false,"schema":{"$ref":"#/definitions/Organization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putOrganizationsOrgId"},"delete":{"tags":["Configuration"],"summary":"Delete an organization.","description":"","operationId":"deleteOrganizationsOrgId","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","description":"Organization ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteOrganizationsOrgId"}},"/api/v1/configuration/recordingkeys":{"get":{"tags":["Configuration"],"summary":"Get encryption key list","description":"","operationId":"getRecordingkeys","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EncryptionKeyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRecordingkeys"},"post":{"tags":["Configuration"],"summary":"Create encryption key","description":"","operationId":"postRecordingkeys","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EncryptionKey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRecordingkeys"}},"/api/v1/configuration/recordingkeys/rotationschedule":{"get":{"tags":["Configuration"],"summary":"Get key rotation schedule","description":"","operationId":"getRecordingkeysRotationschedule","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeyRotationSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRecordingkeysRotationschedule"},"put":{"tags":["Configuration"],"summary":"Update key rotation schedule","description":"","operationId":"putRecordingkeysRotationschedule","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"KeyRotationSchedule","required":false,"schema":{"$ref":"#/definitions/KeyRotationSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeyRotationSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRecordingkeysRotationschedule"}},"/api/v1/configuration/retentionpolicies":{"get":{"tags":["Configuration"],"summary":"Gets retention policy list with query options to filter on name and enabled.","description":"for a less verbose response, add summary=true to this endpoint","operationId":"getRetentionpolicies","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"the policy name - used for filtering results in searches.","required":false,"type":"string"},{"name":"enabled","in":"query","description":"checks to see if policy is enabled - use enabled = true or enabled = false","required":false,"type":"boolean"},{"name":"summary","in":"query","description":"provides a less verbose response of policy lists.","required":false,"type":"boolean","default":false},{"name":"hasErrors","in":"query","description":"provides a way to fetch all policies with errors or policies that do not have errors","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PolicyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRetentionpolicies"},"post":{"tags":["Configuration"],"summary":"Create retention policy","description":"","operationId":"postRetentionpolicies","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Policy","required":false,"schema":{"$ref":"#/definitions/Policy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRetentionpolicies"},"delete":{"tags":["Configuration"],"summary":"Delete policies","description":"Bulk delete of Rules from specified rule set, this will only delete the rules that match the ids specified in the query param.","operationId":"deleteRetentionpolicies","produces":["application/json"],"parameters":[{"name":"ids","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteRetentionpolicies"}},"/api/v1/configuration/retentionpolicies/{policyId}":{"get":{"tags":["Configuration"],"summary":"Get policy","description":"","operationId":"getRetentionpoliciesPolicyId","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRetentionpoliciesPolicyId"},"put":{"tags":["Configuration"],"summary":"Update policy","description":"","operationId":"putRetentionpoliciesPolicyId","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":false,"schema":{"$ref":"#/definitions/Policy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRetentionpoliciesPolicyId"},"delete":{"tags":["Configuration"],"summary":"Delete policy","description":"","operationId":"deleteRetentionpoliciesPolicyId","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteRetentionpoliciesPolicyId"},"patch":{"tags":["Configuration"],"summary":"Patch a retention policy","description":"","operationId":"patchRetentionpoliciesPolicyId","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":false,"schema":{"$ref":"#/definitions/Policy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchRetentionpoliciesPolicyId"}},"/api/v1/configuration/schemas/edges/vnext":{"get":{"tags":["Configuration"],"summary":"Lists available schema categories","description":"","operationId":"getSchemasEdgesVnext","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchemaCategoryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchemasEdgesVnext"}},"/api/v1/configuration/schemas/edges/vnext/{schemaCategory}":{"get":{"tags":["Configuration"],"summary":"List schemas of a specific category","description":"","operationId":"getSchemasEdgesVnextSchemacategory","produces":["application/json"],"parameters":[{"name":"schemaCategory","in":"path","description":"Schema category","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchemaReferenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchemasEdgesVnextSchemacategory"}},"/api/v1/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}":{"get":{"tags":["Configuration"],"summary":"List schemas of a specific category","description":"","operationId":"getSchemasEdgesVnextSchemacategorySchematype","produces":["application/json"],"parameters":[{"name":"schemaCategory","in":"path","description":"Schema category","required":true,"type":"string"},{"name":"schemaType","in":"path","description":"Schema type","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchemaReferenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchemasEdgesVnextSchemacategorySchematype"}},"/api/v1/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}":{"get":{"tags":["Configuration"],"summary":"Get a json schema","description":"","operationId":"getSchemasEdgesVnextSchemacategorySchematypeSchemaId","produces":["application/json"],"parameters":[{"name":"schemaCategory","in":"path","description":"Schema category","required":true,"type":"string"},{"name":"schemaType","in":"path","description":"Schema type","required":true,"type":"string"},{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchemasEdgesVnextSchemacategorySchematypeSchemaId"}},"/api/v1/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}/{extension}/{metadataId}":{"get":{"tags":["Configuration"],"summary":"Get metadata for a schema","description":"","operationId":"getSchemasEdgesVnextSchemacategorySchematypeSchemaIdExtensionMetadataId","produces":["application/json"],"parameters":[{"name":"schemaCategory","in":"path","description":"Schema category","required":true,"type":"string"},{"name":"schemaType","in":"path","description":"Schema type","required":true,"type":"string"},{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"name":"extension","in":"path","description":"extension","required":true,"type":"string"},{"name":"metadataId","in":"path","description":"Metadata ID","required":true,"type":"string"},{"name":"type","in":"query","description":"Type","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchemasEdgesVnextSchemacategorySchematypeSchemaIdExtensionMetadataId"}},"/api/v1/configuration/sites":{"get":{"tags":["Configuration"],"summary":"Get the list of sites.","description":"","operationId":"getSites","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"location.id","in":"query","description":"Location Id","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SiteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSites"},"post":{"tags":["Configuration"],"summary":"Create a endpoint.","description":"","operationId":"postSites","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Site","required":false,"schema":{"$ref":"#/definitions/Site"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSites"}},"/api/v1/configuration/sites/{siteId}":{"get":{"tags":["Configuration"],"summary":"Get endpoint.","description":"","operationId":"getSitesSiteId","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSitesSiteId"},"put":{"tags":["Configuration"],"summary":"Update a endpoint.","description":"","operationId":"putSitesSiteId","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Site","required":false,"schema":{"$ref":"#/definitions/Site"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSitesSiteId"},"delete":{"tags":["Configuration"],"summary":"Delete an ednpoint","description":"","operationId":"deleteSitesSiteId","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSitesSiteId"}},"/api/v1/configuration/sites/{siteId}/numberplans":{"get":{"tags":["Configuration"],"summary":"Get the list of Number Plans for this Site.","description":"","operationId":"getSitesSiteIdNumberplans","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSitesSiteIdNumberplans"},"put":{"tags":["Configuration"],"summary":"Update the list of Number Plans.","description":"","operationId":"putSitesSiteIdNumberplans","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSitesSiteIdNumberplans"}},"/api/v1/configuration/sites/{siteId}/numberplans/classifications":{"get":{"tags":["Configuration"],"summary":"Get a list of Classifications for this Site","description":"","operationId":"getSitesSiteIdNumberplansClassifications","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"classification","in":"query","description":"Classification","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","uniqueItems":true,"items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSitesSiteIdNumberplansClassifications"}},"/api/v1/configuration/sites/{siteId}/numberplans/{numberPlanId}":{"get":{"tags":["Configuration"],"summary":"Get a Number Plan by ID.","description":"","operationId":"getSitesSiteIdNumberplansNumberplanId","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"numberPlanId","in":"path","description":"Number Plan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NumberPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSitesSiteIdNumberplansNumberplanId"}},"/api/v1/configuration/sites/{siteId}/rebalance":{"post":{"tags":["Configuration"],"summary":"Triggers the rebalance operation.","description":"","operationId":"postSitesSiteIdRebalance","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing the Rebalance"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSitesSiteIdRebalance"}},"/api/v1/configuration/uservoicemailpolicies/{userId}":{"get":{"tags":["Voicemail"],"summary":"Get a user's voicemail policy","description":"","operationId":"getUservoicemailpoliciesUserId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUservoicemailpoliciesUserId"},"patch":{"tags":["Voicemail"],"summary":"Update a user's voicemail policy","description":"","operationId":"patchUservoicemailpoliciesUserId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The user's voicemail policy","required":true,"schema":{"$ref":"#/definitions/VoicemailUserPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUservoicemailpoliciesUserId"}},"/api/v1/configuration/voicemailpolicy":{"get":{"tags":["Voicemail"],"summary":"Get a policy","description":"","operationId":"getVoicemailpolicy","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailOrganizationPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getVoicemailpolicy"},"put":{"tags":["Voicemail"],"summary":"Update a policy","description":"","operationId":"putVoicemailpolicy","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Policy","required":false,"schema":{"$ref":"#/definitions/VoicemailOrganizationPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailOrganizationPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putVoicemailpolicy"}},"/api/v1/contentmanagement/auditquery":{"post":{"tags":["Content Management"],"summary":"Query audits","description":"","operationId":"postAuditquery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Allows for a filtered query returning facet information","required":true,"schema":{"$ref":"#/definitions/ContentQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postAuditquery"}},"/api/v1/contentmanagement/documents":{"get":{"tags":["Content Management"],"summary":"Get a list of documents.","description":"","operationId":"getDocuments","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"query","description":"Workspace ID","required":true,"type":"string"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl","workspace"]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"name or dateCreated","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"ascending or descending","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDocuments"},"post":{"tags":["Content Management"],"summary":"Add a document.","description":"","operationId":"postDocuments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Document","required":false,"schema":{"$ref":"#/definitions/DocumentUpload"}},{"name":"copySource","in":"query","description":"Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source.","required":false,"type":"string"},{"name":"moveSource","in":"query","description":"Move a document to a new workspace. Provide a document ID as the move source.","required":false,"type":"string"},{"name":"override","in":"query","description":"Override any lock on the source document","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"423":{"description":"Locked - The source document is locked by another operation"},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDocuments"}},"/api/v1/contentmanagement/documents/{documentId}":{"get":{"tags":["Content Management"],"summary":"Get a document.","description":"","operationId":"getDocumentsDocumentId","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["lockInfo","acl","workspace"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDocumentsDocumentId"},"post":{"tags":["Content Management"],"summary":"Update a document.","description":"","operationId":"postDocumentsDocumentId","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Document","required":false,"schema":{"$ref":"#/definitions/DocumentUpdate"}},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl"]},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"409":{"description":"Resource conflict - Unexpected changeNumber was provided"},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDocumentsDocumentId"},"delete":{"tags":["Content Management"],"summary":"Delete a document.","description":"","operationId":"deleteDocumentsDocumentId","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteDocumentsDocumentId"}},"/api/v1/contentmanagement/documents/{documentId}/audits":{"get":{"tags":["Content Management"],"summary":"Get a list of audits for a document.","description":"","operationId":"getDocumentsDocumentIdAudits","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"transactionFilter","in":"query","description":"Transaction filter","required":false,"type":"string"},{"name":"level","in":"query","description":"level","required":false,"type":"string","default":"USER"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentAuditEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDocumentsDocumentIdAudits"}},"/api/v1/contentmanagement/documents/{documentId}/content":{"get":{"tags":["Content Management"],"summary":"Download a document.","description":"","operationId":"getDocumentsDocumentIdContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"disposition","in":"query","description":"Request how the content will be downloaded: attached as a file or inline. Default is attachment.","required":false,"type":"string","enum":["attachment","inline"]},{"name":"contentType","in":"query","description":"The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav","required":false,"type":"string"}],"responses":{"200":{"description":"Download location returned"},"202":{"description":"Accepted - Preparing file for download - try again soon."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDocumentsDocumentIdContent"},"post":{"tags":["Content Management"],"summary":"Replace the contents of a document.","description":"","operationId":"postDocumentsDocumentIdContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Replace Request","required":false,"schema":{"$ref":"#/definitions/ReplaceRequest"}},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReplaceResponse"}},"202":{"description":"Accepted - Ready for upload"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"409":{"description":"Resource conflict - Unexpected changeNumber was provided"},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDocumentsDocumentIdContent"}},"/api/v1/contentmanagement/query":{"get":{"tags":["Content Management"],"summary":"Query content","description":"","operationId":"getQuery","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"name or dateCreated","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"ascending or descending","required":false,"type":"string","default":"ascending"},{"name":"queryPhrase","in":"query","description":"Phrase tokens are ANDed together over all searchable fields","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl","workspace"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getQuery"},"post":{"tags":["Content Management"],"summary":"Query content","description":"","operationId":"postQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Allows for a filtered query returning facet information","required":true,"schema":{"$ref":"#/definitions/QueryRequest"}},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl","workspace"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQuery"}},"/api/v1/contentmanagement/securityprofiles":{"get":{"tags":["Content Management"],"summary":"Get a List of Security Profiles","description":"","operationId":"getSecurityprofiles","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecurityProfileEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSecurityprofiles"}},"/api/v1/contentmanagement/securityprofiles/{securityProfileId}":{"get":{"tags":["Content Management"],"summary":"Get a Security Profile","description":"","operationId":"getSecurityprofilesSecurityprofileId","produces":["application/json"],"parameters":[{"name":"securityProfileId","in":"path","description":"Security Profile Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecurityProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSecurityprofilesSecurityprofileId"}},"/api/v1/contentmanagement/shared/{sharedId}":{"get":{"tags":["Content Management"],"summary":"Get shared documents. Securely download a shared document.","description":"This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.","operationId":"getSharedSharedId","produces":["application/json"],"parameters":[{"name":"sharedId","in":"path","description":"Shared ID","required":true,"type":"string"},{"name":"redirect","in":"query","description":"Turn on or off redirect","required":false,"type":"boolean","default":true},{"name":"disposition","in":"query","description":"Request how the share content will be downloaded: attached as a file or inline. Default is attachment.","required":false,"type":"string","default":"attachment","enum":["attachment","inline","none"]},{"name":"contentType","in":"query","description":"The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["document.acl"]}],"responses":{"200":{"description":"Download location is returned in header, if redirect is set to false and disposition is not set to none. If disposition is none, location header will not be populated, DownloadUri and ViewUri will be populated."},"202":{"description":"Accepted - Preparing file for download - try again soon."},"307":{"description":"Redirected to download location, if redirect is set to true"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSharedSharedId"}},"/api/v1/contentmanagement/shares":{"get":{"tags":["Content Management"],"summary":"Gets a list of shares.  You must specify at least one filter (e.g. entityId).","description":"Failing to specify a filter will return 400.","operationId":"getShares","produces":["application/json"],"parameters":[{"name":"entityId","in":"query","description":"Filters the shares returned to only the entity specified by the value of this parameter.","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand share fields","required":false,"type":"string","enum":["member"]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShareEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getShares"},"post":{"tags":["Content Management"],"summary":"Creates a new share or updates an existing share if the entity has already been shared","description":"","operationId":"postShares","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CreateShareRequest - entity id and type and a single member or list of members are required","required":false,"schema":{"$ref":"#/definitions/CreateShareRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateShareResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postShares"}},"/api/v1/contentmanagement/shares/{shareId}":{"get":{"tags":["Content Management"],"summary":"Retrieve details about an existing share.","description":"","operationId":"getSharesShareId","produces":["application/json"],"parameters":[{"name":"shareId","in":"path","description":"Share ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand share fields","required":false,"type":"string","enum":["member"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Share"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSharesShareId"},"delete":{"tags":["Content Management"],"summary":"Deletes an existing share.","description":"This revokes sharing rights specified in the share record","operationId":"deleteSharesShareId","produces":["application/json"],"parameters":[{"name":"shareId","in":"path","description":"Share ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSharesShareId"}},"/api/v1/contentmanagement/status":{"get":{"tags":["Content Management"],"summary":"Get a list of statuses for pending operations","description":"","operationId":"getStatus","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommandStatusEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getStatus"}},"/api/v1/contentmanagement/status/{statusId}":{"get":{"tags":["Content Management"],"summary":"Get a status.","description":"","operationId":"getStatusStatusId","produces":["application/json"],"parameters":[{"name":"statusId","in":"path","description":"Status ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommandStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getStatusStatusId"},"delete":{"tags":["Content Management"],"summary":"Cancel the command for this status","description":"","operationId":"deleteStatusStatusId","produces":["application/json"],"parameters":[{"name":"statusId","in":"path","description":"Status ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteStatusStatusId"}},"/api/v1/contentmanagement/workspaces":{"get":{"tags":["Content Management"],"summary":"Get a list of workspaces.","description":"Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to.","operationId":"getWorkspaces","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"access","in":"query","description":"Requested access level","required":false,"type":"string","default":"document:viewmetadata","enum":["content","admin","document:create","document:viewContent","document:viewMetadata","document:download","document:delete","document:update","document:share","document:shareView","document:email","document:print","document:auditView","document:replace","document:tag","tag:create","tag:view","tag:update","tag:apply","tag:remove","tag:delete"]},{"name":"expand","in":"query","description":"Expand some workspace fields","required":false,"type":"string","enum":["summary","acl"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getWorkspaces"},"post":{"tags":["Content Management"],"summary":"Create a group workspace","description":"","operationId":"postWorkspaces","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Workspace","required":false,"schema":{"$ref":"#/definitions/WorkspaceCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postWorkspaces"}},"/api/v1/contentmanagement/workspaces/{workspaceId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace.","description":"","operationId":"getWorkspacesWorkspaceId","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand some workspace fields","required":false,"type":"string","enum":["summary","acl"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getWorkspacesWorkspaceId"},"put":{"tags":["Content Management"],"summary":"Update a workspace","description":"","operationId":"putWorkspacesWorkspaceId","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace","required":false,"schema":{"$ref":"#/definitions/Workspace"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putWorkspacesWorkspaceId"},"delete":{"tags":["Content Management"],"summary":"Delete a workspace","description":"","operationId":"deleteWorkspacesWorkspaceId","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"moveChildrenToWorkspaceId","in":"query","description":"New location for objects in deleted workspace.","required":false,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteWorkspacesWorkspaceId"}},"/api/v1/contentmanagement/workspaces/{workspaceId}/members":{"get":{"tags":["Content Management"],"summary":"Get a list workspace members","description":"","operationId":"getWorkspacesWorkspaceIdMembers","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand workspace member fields","required":false,"type":"string","enum":["member"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getWorkspacesWorkspaceIdMembers"}},"/api/v1/contentmanagement/workspaces/{workspaceId}/members/{memberId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace member","description":"","operationId":"getWorkspacesWorkspaceIdMembersMemberId","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand workspace member fields","required":false,"type":"string","enum":["member"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getWorkspacesWorkspaceIdMembersMemberId"},"put":{"tags":["Content Management"],"summary":"Add a member to a workspace","description":"","operationId":"putWorkspacesWorkspaceIdMembersMemberId","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace","required":false,"schema":{"$ref":"#/definitions/WorkspaceMember"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putWorkspacesWorkspaceIdMembersMemberId"},"delete":{"tags":["Content Management"],"summary":"Delete a member from a workspace","description":"","operationId":"deleteWorkspacesWorkspaceIdMembersMemberId","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteWorkspacesWorkspaceIdMembersMemberId"}},"/api/v1/contentmanagement/workspaces/{workspaceId}/tagvalues":{"get":{"tags":["Content Management"],"summary":"Get a list of workspace tags","description":"","operationId":"getWorkspacesWorkspaceIdTagvalues","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"value","in":"query","description":"filter the list of tags returned","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getWorkspacesWorkspaceIdTagvalues"},"post":{"tags":["Content Management"],"summary":"Create a workspace tag","description":"","operationId":"postWorkspacesWorkspaceIdTagvalues","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"tag","required":false,"schema":{"$ref":"#/definitions/TagValue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postWorkspacesWorkspaceIdTagvalues"}},"/api/v1/contentmanagement/workspaces/{workspaceId}/tagvalues/query":{"post":{"tags":["Content Management"],"summary":"Perform a prefix query on tags in the workspace","description":"","operationId":"postWorkspacesWorkspaceIdTagvaluesQuery","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"query","required":false,"schema":{"$ref":"#/definitions/TagQueryRequest"}},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postWorkspacesWorkspaceIdTagvaluesQuery"}},"/api/v1/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace tag","description":"","operationId":"getWorkspacesWorkspaceIdTagvaluesTagId","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getWorkspacesWorkspaceIdTagvaluesTagId"},"put":{"tags":["Content Management"],"summary":"Update a workspace tag. Will update all documents with the new tag value.","description":"","operationId":"putWorkspacesWorkspaceIdTagvaluesTagId","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace","required":false,"schema":{"$ref":"#/definitions/TagValue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"202":{"description":"Accepted - Processing Update"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putWorkspacesWorkspaceIdTagvaluesTagId"},"delete":{"tags":["Content Management"],"summary":"Delete workspace tag","description":"Delete a tag from a workspace. Will remove this tag from all documents.","operationId":"deleteWorkspacesWorkspaceIdTagvaluesTagId","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteWorkspacesWorkspaceIdTagvaluesTagId"}},"/api/v1/conversations":{"get":{"tags":["Conversations"],"summary":"Get conversations","description":"","operationId":"getConversations","produces":["application/json"],"parameters":[{"name":"communicationType","in":"query","description":"Call or Chat communication filtering","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversations"},"post":{"tags":["Conversations"],"summary":"Create conversation","description":"","operationId":"postConversations","produces":["application/json"],"parameters":[{"name":"call","in":"query","description":"Phone number to call","required":false,"type":"string"},{"name":"callFrom","in":"query","description":"Queue id to place the call from","required":false,"type":"string"},{"name":"callQueueId","in":"query","description":"Queue id to call","required":false,"type":"string"},{"name":"callUserId","in":"query","description":"User id to call (this will call the default number)","required":false,"type":"string"},{"name":"priority","in":"query","description":"Priority level to use for routing when calling a queue","required":false,"type":"integer","format":"int32"},{"name":"languageId","in":"query","description":"Language id to use for routing when calling a queue","required":false,"type":"string"},{"name":"skillIds","in":"query","description":"Skill ids to use for routing when calling a queue","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"in":"body","name":"body","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversations"}},"/api/v1/conversations/fax":{"post":{"tags":["Conversations"],"summary":"Create Fax Conversation","description":"","operationId":"postFax","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Fax","required":false,"schema":{"$ref":"#/definitions/FaxSendRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxSendResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postFax"}},"/api/v1/conversations/maximumconferenceparties":{"get":{"tags":["Conversations"],"summary":"Get the maximum number of participants that this user can have on a conference","description":"","operationId":"getMaximumconferenceparties","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MaxParticipants"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMaximumconferenceparties"}},"/api/v1/conversations/query":{"post":{"tags":["Conversations"],"summary":"Query historical conversations","description":"","operationId":"postQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Query parameters","required":true,"schema":{"$ref":"#/definitions/ConversationHistoricalQueryRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQuery"}},"/api/v1/conversations/query/{anchor}":{"post":{"tags":["Conversations"],"summary":"Query historical conversations with a date/time anchor","description":"","operationId":"postQueryAnchor","produces":["application/json"],"parameters":[{"name":"anchor","in":"path","description":"A point in time within the interval for the query that bounds the query. In the form of YYYYMMDDHHmmssSSSZX where YYYY is the 4-digit year, MM is the 2-digit month, DD is the 2-digit day-of-month, HH is the 2-digit hour-of-day (00-23), mm is the 2-digit minute, ss is the 2-digit second, SSS is the 3-digit millisecond, Z is the UTC offset expressed as 'Z', '+nnnn', '-nnnn', '+nn:nn', '-nn:nn', and X is either 'A' (for the anchor point being at the earliest point in the query) or 'D' (for the anchor point being the latest point in the query","required":true,"type":"string"},{"in":"body","name":"body","description":"Query parameters","required":true,"schema":{"$ref":"#/definitions/ConversationHistoricalQueryRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQueryAnchor"}},"/api/v1/conversations/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get conversation","description":"","operationId":"getConversationId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationId"},"put":{"tags":["Conversations"],"summary":"Update conversation","description":"","operationId":"putConversationId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":false,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putConversationId"}},"/api/v1/conversations/{conversationId}/calls":{"post":{"tags":["Conversations"],"summary":"Add a new call to a conversation","description":"","operationId":"postConversationIdCalls","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":false,"schema":{"$ref":"#/definitions/CallCommand"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdCalls"}},"/api/v1/conversations/{conversationId}/messages":{"get":{"tags":["Conversations"],"summary":"Get conversation messages","description":"","operationId":"getConversationIdMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessageListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdMessages"},"post":{"tags":["Conversations"],"summary":"Send an email reply","description":"","operationId":"postConversationIdMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Reply","required":false,"schema":{"$ref":"#/definitions/EmailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdMessages"}},"/api/v1/conversations/{conversationId}/messages/draft":{"get":{"tags":["Conversations"],"summary":"Get conversation draft reply","description":"","operationId":"getConversationIdMessagesDraft","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdMessagesDraft"},"put":{"tags":["Conversations"],"summary":"Update conversation draft reply","description":"","operationId":"putConversationIdMessagesDraft","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Draft","required":false,"schema":{"$ref":"#/definitions/EmailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putConversationIdMessagesDraft"}},"/api/v1/conversations/{conversationId}/messages/draft/attachments/{attachmentId}":{"delete":{"tags":["Conversations"],"summary":"Delete attachment from draft","description":"","operationId":"deleteConversationIdMessagesDraftAttachmentsAttachmentId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"attachmentId","in":"path","description":"attachment ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteConversationIdMessagesDraftAttachmentsAttachmentId"}},"/api/v1/conversations/{conversationId}/messages/{id}":{"get":{"tags":["Conversations"],"summary":"Get conversation message","description":"","operationId":"getConversationIdMessagesId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"id","in":"path","description":"message ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdMessagesId"}},"/api/v1/conversations/{conversationId}/participants":{"post":{"tags":["Conversations"],"summary":"Add participants to a conversation","description":"","operationId":"postConversationIdParticipants","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":false,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdParticipants"}},"/api/v1/conversations/{conversationId}/participants/{participantId}":{"put":{"tags":["Conversations"],"summary":"Update a participant.","description":"Specify the state as CONNECTED, DISCONNECTED. You can specify a wrap-up code.","operationId":"putConversationIdParticipantsParticipantId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putConversationIdParticipantsParticipantId"}},"/api/v1/conversations/{conversationId}/participants/{participantId}/attributes":{"put":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"putConversationIdParticipantsParticipantIdAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putConversationIdParticipantsParticipantIdAttributes"}},"/api/v1/conversations/{conversationId}/participants/{participantId}/callbacks":{"post":{"tags":["Conversations"],"summary":"Create a new callback for the specified participant on the conversation.","description":"","operationId":"postConversationIdParticipantsParticipantIdCallbacks","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateCallbackCommand"}}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdParticipantsParticipantIdCallbacks"}},"/api/v1/conversations/{conversationId}/participants/{participantId}/consult":{"post":{"tags":["Conversations"],"summary":"Initiate and update consult transfer","description":"","operationId":"postConversationIdParticipantsParticipantIdConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"The object of the transfer","required":true,"type":"string"},{"in":"body","name":"body","description":"Destination address & initial speak to","required":false,"schema":{"$ref":"#/definitions/ConsultTransfer"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdParticipantsParticipantIdConsult"},"put":{"tags":["Conversations"],"summary":"Change who can speak","description":"","operationId":"putConversationIdParticipantsParticipantIdConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"The object of the transfer","required":true,"type":"string"},{"in":"body","name":"body","description":"new speak to","required":false,"schema":{"$ref":"#/definitions/ConsultTransferUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putConversationIdParticipantsParticipantIdConsult"},"delete":{"tags":["Conversations"],"summary":"Cancel the transfer","description":"","operationId":"deleteConversationIdParticipantsParticipantIdConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"The object of the transfer","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteConversationIdParticipantsParticipantIdConsult"}},"/api/v1/conversations/{conversationId}/participants/{participantId}/monitor":{"post":{"tags":["Conversations"],"summary":"Listen in on the conversation from the point of view of a given participant.","description":"","operationId":"postConversationIdParticipantsParticipantIdMonitor","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdParticipantsParticipantIdMonitor"}},"/api/v1/conversations/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationIdParticipantsParticipantIdReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"name":"userId","in":"query","description":"The user that will replace this participant.  If address is not supplied then the user's Work address will be used.  This parameter is required when replacing a participant that has an active chat.","required":false,"type":"string"},{"name":"address","in":"query","description":"The address that will be used to contact the new participant","required":false,"type":"string"},{"name":"username","in":"query","description":"The username of the person that will replace this participant.  This field is only used if the userId is blank.","required":false,"type":"string"},{"name":"queueId","in":"query","description":"The id of the queue that will replace this participant.","required":false,"type":"string"},{"name":"voicemail","in":"query","description":"Indicates this participant will be replaced by the voicemail inbox of the participant.","required":false,"type":"boolean"}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdParticipantsParticipantIdReplace"}},"/api/v1/conversations/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationIdParticipantsParticipantIdWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdParticipantsParticipantIdWrapup"}},"/api/v1/conversations/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationIdParticipantsParticipantIdWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdParticipantsParticipantIdWrapupcodes"}},"/api/v1/conversations/{conversationId}/recordings":{"get":{"tags":["Recording"],"summary":"Get all of a Conversation's Recordings.","description":"","operationId":"getConversationIdRecordings","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"maxWaitMs","in":"query","description":"The maximum number of milliseconds to wait for the recording to be ready.","required":false,"type":"integer","default":5000,"format":"int32","enum":["Any integer greater than or equal to 0."]},{"name":"formatId","in":"query","description":"The desired format (WEBM, WAV, etc.)","required":false,"type":"string","default":"WEBM","enum":["WEBM","WAV"]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Recording"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdRecordings"}},"/api/v1/conversations/{conversationId}/recordings/{recordingId}":{"get":{"tags":["Recording"],"summary":"Gets a specific recording.","description":"","operationId":"getConversationIdRecordingsRecordingId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"maxWaitMs","in":"query","description":"The maximum number of milliseconds to wait for completion.","required":false,"type":"integer","format":"int32","enum":["Any integer greater than or equal to 0."]},{"name":"formatId","in":"query","description":"The desired format (WEBM, WAV, etc.)","required":false,"type":"string","default":"WEBM","enum":["WEBM","WAV"]},{"name":"download","in":"query","description":"requesting a download format of the recording","required":false,"type":"boolean","default":false,"enum":["true","false"]},{"name":"fileName","in":"query","description":"the name of the downloaded fileName","required":false,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdRecordingsRecordingId"},"put":{"tags":["Recording"],"summary":"Updates the retention records on a recording.","description":"Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. Use of the query parameter 'restoreDays' is deprecated and will be removed in the next major version release. If 'restoreDays' is provided, no attempt at updating other retention data will be made. To migrate to the new usage, issuing a request with restoreDays=10 would instead set the archiveDate's time stamp in the PUT body to 10 days in the future.","operationId":"putConversationIdRecordingsRecordingId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"in":"body","name":"body","description":"recording","required":true,"schema":{"$ref":"#/definitions/Recording"}},{"name":"restoreDays","in":"query","description":"The number of days the recording will be available before it is re-archived. Deprecated.","required":false,"type":"integer","format":"int32","enum":["Any integer greater than or equal to 1."]}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putConversationIdRecordingsRecordingId"}},"/api/v1/conversations/{conversationId}/recordings/{recordingId}/annotations":{"get":{"tags":["Recording"],"summary":"Get annotations for recording","description":"","operationId":"getConversationIdRecordingsRecordingIdAnnotations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Annotation"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdRecordingsRecordingIdAnnotations"},"post":{"tags":["Recording"],"summary":"Create annotation","description":"","operationId":"postConversationIdRecordingsRecordingIdAnnotations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"in":"body","name":"body","description":"annotation","required":false,"schema":{"$ref":"#/definitions/Annotation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdRecordingsRecordingIdAnnotations"}},"/api/v1/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}":{"get":{"tags":["Recording"],"summary":"Get annotation","description":"","operationId":"getConversationIdRecordingsRecordingIdAnnotationsAnnotationId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdRecordingsRecordingIdAnnotationsAnnotationId"},"put":{"tags":["Recording"],"summary":"Update annotation","description":"","operationId":"putConversationIdRecordingsRecordingIdAnnotationsAnnotationId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"annotation","required":false,"schema":{"$ref":"#/definitions/Annotation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putConversationIdRecordingsRecordingIdAnnotationsAnnotationId"},"delete":{"tags":["Recording"],"summary":"Delete annotation","description":"","operationId":"deleteConversationIdRecordingsRecordingIdAnnotationsAnnotationId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteConversationIdRecordingsRecordingIdAnnotationsAnnotationId"}},"/api/v1/conversations/{conversationId}/tags":{"get":{"tags":["Conversations"],"summary":"Get possible tags for Conversation","description":"","operationId":"getConversationIdTags","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Tag"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdTags"}},"/api/v1/conversations/{conversationId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get possible wrap-up codes for Conversation","description":"","operationId":"getConversationIdWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdWrapupcodes"}},"/api/v1/date":{"get":{"tags":["Utilities"],"summary":"Get the current system date/time","description":"","operationId":"getDate","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServerDate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDate"}},"/api/v1/downloads/callback":{"get":{"tags":["Downloads"],"summary":"OAuth Callback used during code authorization grant flow.","description":"","operationId":"getCallback","produces":["application/json"],"parameters":[{"name":"code","in":"query","required":false,"type":"string"},{"name":"state","in":"query","required":false,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallback"}},"/api/v1/downloads/{downloadId}":{"get":{"tags":["Downloads"],"summary":"Issues a redirect to a signed secure download URL for specified download","description":"this method will issue a redirect to the url to the content","operationId":"getDownloadId","produces":["application/json"],"parameters":[{"name":"downloadId","in":"path","description":"Download ID","required":true,"type":"string"},{"name":"contentDisposition","in":"query","required":false,"type":"string","default":"attachment"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDownloadId"}},"/api/v1/externalcontacts/contacts":{"get":{"tags":["External Contacts"],"summary":"Search for External Contacts","description":"","operationId":"getContacts","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"User supplied search keywords (no special syntax is currently supported)","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["[externalOrganization]"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContacts"},"post":{"tags":["External Contacts"],"summary":"Create an ExternalContact","description":"","operationId":"postContacts","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExternalContact","required":false,"schema":{"$ref":"#/definitions/ExternalContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postContacts"}},"/api/v1/externalcontacts/contacts/{contactId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a ExternalContact","description":"","operationId":"getContactsContactId","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["[externalOrganization]"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContactsContactId"},"put":{"tags":["External Contacts"],"summary":"Update a externalContact","description":"","operationId":"putContactsContactId","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":false,"schema":{"$ref":"#/definitions/ExternalContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putContactsContactId"},"delete":{"tags":["External Contacts"],"summary":"Delete a contact","description":"","operationId":"deleteContactsContactId","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteContactsContactId"}},"/api/v1/externalcontacts/contacts/{contactId}/notes":{"get":{"tags":["External Contacts"],"summary":"List Notes for an ExternalContact","description":"","operationId":"getContactsContactIdNotes","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NoteListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContactsContactIdNotes"},"post":{"tags":["External Contacts"],"summary":"Create a Note for an ExternalContact","description":"","operationId":"postContactsContactIdNotes","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":false,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postContactsContactIdNotes"}},"/api/v1/externalcontacts/contacts/{contactId}/notes/{noteId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a note for a contact","description":"","operationId":"getContactsContactIdNotesNoteId","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContactsContactIdNotesNoteId"},"put":{"tags":["External Contacts"],"summary":"Update a note for a contact","description":"","operationId":"putContactsContactIdNotesNoteId","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Note","required":false,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putContactsContactIdNotesNoteId"},"delete":{"tags":["External Contacts"],"summary":"Delete a note for a contact","description":"","operationId":"deleteContactsContactIdNotesNoteId","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteContactsContactIdNotesNoteId"}},"/api/v1/externalcontacts/organizations":{"get":{"tags":["External Contacts"],"summary":"Search for External Organizations","description":"","operationId":"getOrganizations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"Search query","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganizationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrganizations"},"post":{"tags":["External Contacts"],"summary":"Create an External Organization","description":"","operationId":"postOrganizations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExternalOrganization","required":false,"schema":{"$ref":"#/definitions/ExternalOrganization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postOrganizations"}},"/api/v1/externalcontacts/organizations/{externalOrganizationId}":{"get":{"tags":["External Contacts"],"summary":"Fetch an External Organization","description":"","operationId":"getOrganizationsExternalorganizationId","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrganizationsExternalorganizationId"},"put":{"tags":["External Contacts"],"summary":"Update an External Organization","description":"","operationId":"putOrganizationsExternalorganizationId","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalOrganization","required":false,"schema":{"$ref":"#/definitions/ExternalOrganization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putOrganizationsExternalorganizationId"},"delete":{"tags":["External Contacts"],"summary":"Delete an External Organization","description":"","operationId":"deleteOrganizationsExternalorganizationId","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteOrganizationsExternalorganizationId"}},"/api/v1/externalcontacts/organizations/{externalOrganizationId}/contacts":{"get":{"tags":["External Contacts"],"summary":"Search for External Contacts","description":"","operationId":"getOrganizationsExternalorganizationIdContacts","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"User supplied search keywords (no special syntax is currently supported)","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["[externalOrganization]"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrganizationsExternalorganizationIdContacts"}},"/api/v1/externalcontacts/organizations/{externalOrganizationId}/notes":{"get":{"tags":["External Contacts"],"summary":"List Notes for an External Organization","description":"","operationId":"getOrganizationsExternalorganizationIdNotes","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NoteListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrganizationsExternalorganizationIdNotes"},"post":{"tags":["External Contacts"],"summary":"Create a Note for an External Organization","description":"","operationId":"postOrganizationsExternalorganizationIdNotes","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":false,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postOrganizationsExternalorganizationIdNotes"}},"/api/v1/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a note","description":"","operationId":"getOrganizationsExternalorganizationIdNotesNoteId","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrganizationsExternalorganizationIdNotesNoteId"},"put":{"tags":["External Contacts"],"summary":"Update a note","description":"","operationId":"putOrganizationsExternalorganizationIdNotesNoteId","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Note","required":false,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putOrganizationsExternalorganizationIdNotesNoteId"},"delete":{"tags":["External Contacts"],"summary":"Delete a note","description":"","operationId":"deleteOrganizationsExternalorganizationIdNotesNoteId","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteOrganizationsExternalorganizationIdNotesNoteId"}},"/api/v1/externalcontacts/organizations/{externalOrganizationId}/relationships":{"get":{"tags":["External Contacts"],"summary":"Fetch an External Organization","description":"","operationId":"getOrganizationsExternalorganizationIdRelationships","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RelationshipListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrganizationsExternalorganizationIdRelationships"}},"/api/v1/externalcontacts/relationships":{"post":{"tags":["External Contacts"],"summary":"Create a relationship","description":"","operationId":"postRelationships","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Relationship","required":false,"schema":{"$ref":"#/definitions/Relationship"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRelationships"}},"/api/v1/externalcontacts/relationships/{relationshipId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a relationship","description":"","operationId":"getRelationshipsRelationshipId","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRelationshipsRelationshipId"},"put":{"tags":["External Contacts"],"summary":"Update a relationship","description":"","operationId":"putRelationshipsRelationshipId","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Relationship","required":false,"schema":{"$ref":"#/definitions/Relationship"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRelationshipsRelationshipId"},"delete":{"tags":["External Contacts"],"summary":"Delete a relationship","description":"","operationId":"deleteRelationshipsRelationshipId","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteRelationshipsRelationshipId"}},"/api/v1/fax/documents":{"get":{"tags":["Fax"],"summary":"Get a list of fax documents.","description":"","operationId":"getDocuments","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocumentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDocuments"}},"/api/v1/fax/documents/{documentId}":{"get":{"tags":["Fax"],"summary":"Get a document.","description":"","operationId":"getDocumentsDocumentId","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDocumentsDocumentId"},"put":{"tags":["Fax"],"summary":"Update a fax document.","description":"","operationId":"putDocumentsDocumentId","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Document","required":false,"schema":{"$ref":"#/definitions/FaxDocument"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putDocumentsDocumentId"},"delete":{"tags":["Fax"],"summary":"Delete a fax document.","description":"","operationId":"deleteDocumentsDocumentId","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteDocumentsDocumentId"}},"/api/v1/fax/documents/{documentId}/content":{"get":{"tags":["Fax"],"summary":"Download a fax document.","description":"","operationId":"getDocumentsDocumentIdContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DownloadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDocumentsDocumentIdContent"}},"/api/v1/fax/summary":{"get":{"tags":["Fax"],"summary":"Get fax summary","description":"","operationId":"getSummary","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxSummary"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSummary"}},"/api/v1/flows":{"get":{"tags":["Architect"],"summary":"Get a pageable list of flows, filtered by query parameters","description":"Multiple IDs can be specified, in which case all matching flows will be returned, and no other parameters will be evaluated.","operationId":"getFlows","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"Type","required":false,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"},{"name":"publishVersionId","in":"query","description":"Publish version ID","required":false,"type":"string"},{"name":"editableBy","in":"query","description":"Editable by","required":false,"type":"string"},{"name":"lockedBy","in":"query","description":"Locked by","required":false,"type":"string"},{"name":"deleted","in":"query","description":"Include deleted","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFlows"},"post":{"tags":["Architect"],"summary":"Create flow","description":"","operationId":"postFlows","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Flow"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postFlows"},"delete":{"tags":["Architect"],"summary":"Batch-delete a list of flows","description":"Multiple IDs can be specified, in which case all specified flows will be deleted.","operationId":"deleteFlows","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"List of Flow IDs","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"ignoreDependencies","in":"query","description":"Ignore Dependencies","required":false,"type":"boolean","default":false}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteFlows"}},"/api/v1/flows/actions/checkin":{"post":{"tags":["Architect"],"summary":"Check-in flow","description":"","operationId":"postActionsCheckin","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postActionsCheckin"}},"/api/v1/flows/actions/checkout":{"post":{"tags":["Architect"],"summary":"Check-out flow","description":"","operationId":"postActionsCheckout","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postActionsCheckout"}},"/api/v1/flows/actions/deactivate":{"post":{"tags":["Architect"],"summary":"Deactivate flow","description":"","operationId":"postActionsDeactivate","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postActionsDeactivate"}},"/api/v1/flows/actions/debug":{"post":{"tags":["Architect"],"summary":"Debug flow","description":"","operationId":"postActionsDebug","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow","required":false,"type":"string"},{"name":"version","in":"query","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postActionsDebug"}},"/api/v1/flows/actions/revert":{"post":{"tags":["Architect"],"summary":"Revert flow","description":"","operationId":"postActionsRevert","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postActionsRevert"}},"/api/v1/flows/{flowId}":{"get":{"tags":["Architect"],"summary":"Get flow.","description":"","operationId":"getFlowId","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFlowId"},"put":{"tags":["Architect"],"summary":"Update flow.","description":"","operationId":"putFlowId","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Flow"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putFlowId"},"delete":{"tags":["Architect"],"summary":"Delete flow.","description":"","operationId":"deleteFlowId","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteFlowId"}},"/api/v1/flows/{flowId}/latestconfiguration":{"get":{"tags":["Architect"],"summary":"Get the latest configuration for flow.","description":"","operationId":"getFlowIdLatestconfiguration","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFlowIdLatestconfiguration"}},"/api/v1/flows/{flowId}/publishedresults/{id}":{"get":{"tags":["Architect"],"summary":"Get generation result.","description":"","operationId":"getFlowIdPublishedresultsId","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"id","in":"path","description":"Publish Result ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PublishedResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFlowIdPublishedresultsId"}},"/api/v1/flows/{flowId}/versions":{"get":{"tags":["Architect"],"summary":"Get flow version list","description":"","operationId":"getFlowIdVersions","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"deleted","in":"query","description":"Deleted","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowVersionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFlowIdVersions"},"post":{"tags":["Architect"],"summary":"Create flow version","description":"","operationId":"postFlowIdVersions","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postFlowIdVersions"}},"/api/v1/flows/{flowId}/versions/{versionId}":{"get":{"tags":["Architect"],"summary":"Get flow version","description":"","operationId":"getFlowIdVersionsVersionId","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Version ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFlowIdVersionsVersionId"}},"/api/v1/flows/{flowId}/versions/{versionId}/configuration":{"get":{"tags":["Architect"],"summary":"Create flow version configuration","description":"","operationId":"getFlowIdVersionsVersionIdConfiguration","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Version ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFlowIdVersionsVersionIdConfiguration"}},"/api/v1/geolocations/settings":{"get":{"tags":["Geolocation"],"summary":"Get a organization's GeolocationSettings","description":"","operationId":"getSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeolocationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSettings"},"patch":{"tags":["Geolocation"],"summary":"Patch a organization's GeolocationSettings","description":"","operationId":"patchSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/GeolocationSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeolocationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchSettings"}},"/api/v1/greetings":{"get":{"tags":["Greetings"],"summary":"Gets an Organization's Greetings","description":"","operationId":"getGreetings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getGreetings"},"post":{"tags":["Greetings"],"summary":"Create a Greeting for an Organization","description":"","operationId":"postGreetings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Greeting to create","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postGreetings"}},"/api/v1/greetings/defaults":{"get":{"tags":["Greetings"],"summary":"Get an Organization's DefaultGreetingList","description":"","operationId":"getDefaults","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDefaults"},"put":{"tags":["Greetings"],"summary":"Update an Organization's DefaultGreetingList","description":"","operationId":"putDefaults","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The updated defaultGreetingList","required":true,"schema":{"$ref":"#/definitions/DefaultGreetingList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putDefaults"}},"/api/v1/greetings/{greetingId}":{"get":{"tags":["Greetings"],"summary":"Get a Greeting with the given GreetingId","description":"","operationId":"getGreetingId","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getGreetingId"},"put":{"tags":["Greetings"],"summary":"Updates the Greeting with the given GreetingId","description":"","operationId":"putGreetingId","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated Greeting","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putGreetingId"},"delete":{"tags":["Greetings"],"summary":"Deletes a Greeting with the given GreetingId","description":"","operationId":"deleteGreetingId","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteGreetingId"}},"/api/v1/greetings/{greetingId}/media":{"get":{"tags":["Greetings"],"summary":"Get media playback URI for this greeting","description":"","operationId":"getGreetingIdMedia","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired format (WAV, etc.)","required":false,"type":"string","default":"WAV","enum":["WAV"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GreetingMediaInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getGreetingIdMedia"}},"/api/v1/groups":{"get":{"tags":["Groups"],"summary":"Get a group list","description":"","operationId":"getGroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["[ascending","descending]"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getGroups"}},"/api/v1/groups/{groupId}":{"get":{"tags":["Groups"],"summary":"Get group","description":"","operationId":"getGroupId","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getGroupId"}},"/api/v1/groups/{groupId}/members":{"get":{"tags":["Groups"],"summary":"Get group members","description":"","operationId":"getGroupIdMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["[ascending","descending]"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getGroupIdMembers"}},"/api/v1/health/check":{"get":{"tags":["Utilities"],"summary":"Get health.","description":"","operationId":"getCheck","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HealthCheckInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCheck"}},"/api/v1/identityproviders":{"get":{"tags":["OAuth"],"summary":"The list of identity providers","description":"","operationId":"getIdentityproviders","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProviderEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getIdentityproviders"}},"/api/v1/identityproviders/okta":{"get":{"tags":["OAuth"],"summary":"Get Okta Identity Provider","description":"","operationId":"getOkta","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Okta"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOkta"},"put":{"tags":["OAuth"],"summary":"Update/Create Okta Identity Provider","description":"","operationId":"putOkta","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":false,"schema":{"$ref":"#/definitions/Okta"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putOkta"},"delete":{"tags":["OAuth"],"summary":"Delete Okta Identity Provider","description":"","operationId":"deleteOkta","produces":["application/json"],"parameters":[],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteOkta"}},"/api/v1/identityproviders/onelogin":{"get":{"tags":["OAuth"],"summary":"Get OneLogin Identity Provider","description":"","operationId":"getOnelogin","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OneLogin"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOnelogin"},"put":{"tags":["OAuth"],"summary":"Update/Create OneLogin Identity Provider","description":"","operationId":"putOnelogin","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":false,"schema":{"$ref":"#/definitions/OneLogin"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putOnelogin"},"delete":{"tags":["OAuth"],"summary":"Delete OneLogin Identity Provider","description":"","operationId":"deleteOnelogin","produces":["application/json"],"parameters":[],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteOnelogin"}},"/api/v1/identityproviders/purecloud":{"get":{"tags":["OAuth"],"summary":"Get PureCloud Identity Provider","description":"","operationId":"getPurecloud","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PureCloud"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPurecloud"},"put":{"tags":["OAuth"],"summary":"Update/Create PureCloud Identity Provider","description":"","operationId":"putPurecloud","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":false,"schema":{"$ref":"#/definitions/PureCloud"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putPurecloud"},"delete":{"tags":["OAuth"],"summary":"Delete PureCloud Identity Provider","description":"","operationId":"deletePurecloud","produces":["application/json"],"parameters":[],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deletePurecloud"}},"/api/v1/identityproviders/salesforce":{"get":{"tags":["OAuth"],"summary":"Get Salesforce Identity Provider","description":"","operationId":"getSalesforce","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Salesforce"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSalesforce"},"put":{"tags":["OAuth"],"summary":"Update/Create Salesforce Identity Provider","description":"","operationId":"putSalesforce","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":false,"schema":{"$ref":"#/definitions/Salesforce"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSalesforce"},"delete":{"tags":["OAuth"],"summary":"Delete Salesforce Identity Provider","description":"","operationId":"deleteSalesforce","produces":["application/json"],"parameters":[],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSalesforce"}},"/api/v1/identityproviders/{providerId}":{"get":{"tags":["OAuth"],"summary":"Get an identity provider","description":"","operationId":"getProviderId","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProviderId"},"put":{"tags":["OAuth"],"summary":"Update an identity provider","description":"","operationId":"putProviderId","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":false,"schema":{"$ref":"#/definitions/OAuthProvider"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProviderId"},"delete":{"tags":["OAuth"],"summary":"Delete an identity provider","description":"","operationId":"deleteProviderId","produces":["application/json"],"parameters":[],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProviderId"}},"/api/v1/languages":{"get":{"tags":["Languages"],"summary":"Get the list of supported languages.","description":"","operationId":"getLanguages","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["[ascending","descending]"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LanguageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLanguages"}},"/api/v1/languages/{languageId}":{"get":{"tags":["Languages"],"summary":"Get language","description":"","operationId":"getLanguageId","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLanguageId"}},"/api/v1/licensing/licenses":{"get":{"tags":["Licensing"],"summary":"Get Licenses required for a set of permissions.","description":"","operationId":"getLicenses","produces":["application/json"],"parameters":[{"name":"permission","in":"query","description":"Permission","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/License"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLicenses"}},"/api/v1/licensing/orgassignments":{"get":{"tags":["Licensing"],"summary":"Get org license assignments.","description":"","operationId":"getOrgassignments","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrgLicenseAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrgassignments"}},"/api/v1/licensing/orgassignments/{id}":{"get":{"tags":["Licensing"],"summary":"Get org license assignment.","description":"","operationId":"getOrgassignmentsId","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrgLicenseAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrgassignmentsId"}},"/api/v1/licensing/permissions":{"get":{"tags":["Licensing"],"summary":"Get Licenses required per permission.","description":"","operationId":"getPermissions","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/LicensesByPermission"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPermissions"},"post":{"tags":["Licensing"],"summary":"Get Licenses required per permission.","description":"","operationId":"postPermissions","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"in":"body","name":"body","description":"The permissions details","required":false,"schema":{"$ref":"#/definitions/Permissions"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/LicensesByPermission"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postPermissions"}},"/api/v1/licensing/userassignments":{"get":{"tags":["Licensing"],"summary":"Get user license assignments.","description":"","operationId":"getUserassignments","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserLicenseAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserassignments"}},"/api/v1/licensing/userassignments/{id}":{"get":{"tags":["Licensing"],"summary":"Get user license assignment.","description":"","operationId":"getUserassignmentsId","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserLicenseAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserassignmentsId"}},"/api/v1/locations":{"get":{"tags":["Locations"],"summary":"Get the list of locations.","description":"","operationId":"getLocations","produces":["application/json"],"parameters":[{"name":"state","in":"query","description":"Location state","required":false,"type":"string","default":"ACTIVE","enum":["ACTIVE","DELETED"]},{"name":"name","in":"query","description":"Location name","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLocations"}},"/api/v1/locations/{locationId}":{"get":{"tags":["Locations"],"summary":"Get Location by ID.","description":"","operationId":"getLocationId","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Location"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLocationId"}},"/api/v1/notifications/availabletopics":{"get":{"tags":["Notifications"],"summary":"Get available notification topics.","description":"","operationId":"getAvailabletopics","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getAvailabletopics"}},"/api/v1/notifications/channels":{"get":{"tags":["Notifications"],"summary":"The list of existing channels","description":"","operationId":"getChannels","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getChannels"},"post":{"tags":["Notifications"],"summary":"Create a new channel","description":"There is a limit of 10 channels. Creating an 11th channel will remove the channel with oldest last used date.","operationId":"postChannels","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Channel"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postChannels"}},"/api/v1/notifications/channels/{channelId}/subscriptions":{"get":{"tags":["Notifications"],"summary":"The list of all subscriptions for this channel","description":"","operationId":"getChannelsChannelIdSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getChannelsChannelIdSubscriptions"},"post":{"tags":["Notifications"],"summary":"Add a list of subscriptions to the existing list of subscriptions","description":"","operationId":"postChannelsChannelIdSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Topic","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/ChannelTopic"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postChannelsChannelIdSubscriptions"},"put":{"tags":["Notifications"],"summary":"Replace the current list of subscriptions with a new list.","description":"","operationId":"putChannelsChannelIdSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Topic","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/ChannelTopic"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putChannelsChannelIdSubscriptions"},"delete":{"tags":["Notifications"],"summary":"Remove all subscriptions","description":"","operationId":"deleteChannelsChannelIdSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteChannelsChannelIdSubscriptions"}},"/api/v1/oauth/clients":{"get":{"tags":["OAuth"],"summary":"The list of OAuth clients","description":"","operationId":"getClients","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClientEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getClients"},"post":{"tags":["OAuth"],"summary":"Create OAuth client","description":"The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. \nThe preferred authorizedGrantTypes is 'CODE' which requires applications to send a client ID and client secret. This is typically a web server. \nIf the client is unable to secure the client secret then the 'TOKEN' grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. \nIf a client is to be used outside of the context of a user then the 'CLIENT-CREDENTIALS' grant may be used. In this case the client must be granted roles \nvia the 'roleIds' field.","operationId":"postClients","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Client","required":false,"schema":{"$ref":"#/definitions/OAuthClient"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postClients"}},"/api/v1/oauth/clients/{clientId}":{"get":{"tags":["OAuth"],"summary":"Get OAuth Client","description":"","operationId":"getClientsClientId","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getClientsClientId"},"put":{"tags":["OAuth"],"summary":"Update OAuth Client","description":"","operationId":"putClientsClientId","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Client","required":false,"schema":{"$ref":"#/definitions/OAuthClient"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putClientsClientId"},"delete":{"tags":["OAuth"],"summary":"Delete OAuth Client","description":"","operationId":"deleteClientsClientId","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteClientsClientId"}},"/api/v1/oauth/clients/{clientId}/secret":{"post":{"tags":["OAuth"],"summary":"Regenerate Client Secret","description":"This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.","operationId":"postClientsClientIdSecret","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postClientsClientIdSecret"}},"/api/v1/orphanrecordings":{"get":{"tags":["Recording"],"summary":"Gets all orphan recordings","description":"","operationId":"getOrphanrecordings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecordingListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrphanrecordings"}},"/api/v1/orphanrecordings/{orphanId}":{"get":{"tags":["Recording"],"summary":"Gets a single orphan recording","description":"","operationId":"getOrphanId","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrphanId"},"delete":{"tags":["Recording"],"summary":" deletes a single orphan recording","description":"","operationId":"deleteOrphanId","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteOrphanId"}},"/api/v1/outbound/audits":{"post":{"tags":["Outbound"],"summary":"Retrieves audits for dialer.","description":"","operationId":"postAudits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"AuditSearch","required":false,"schema":{"$ref":"#/definitions/DialerAuditRequest"}},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"entity.name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"},{"name":"facetsOnly","in":"query","description":"Facets only","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditSearchResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postAudits"}},"/api/v1/outbound/callabletimesets":{"get":{"tags":["Outbound"],"summary":"Query callable time set list","description":"","operationId":"getCallabletimesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"PREFIX","enum":["EQUALS","REGEX","CONTAINS","PREFIX","LESSTHAN","LESSTHANEQUALTO","GREATERTHAN","GREATERTHANEQUALTO","BEGINSWITH","ENDSWITH"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallabletimesets"},"post":{"tags":["Outbound"],"summary":"Create callable time set","description":"","operationId":"postCallabletimesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"DialerCallableTimeSet","required":false,"schema":{"$ref":"#/definitions/CallableTimeSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallabletimesets"}},"/api/v1/outbound/callabletimesets/{callableTimeSetId}":{"get":{"tags":["Outbound"],"summary":"Get callable time set","description":"","operationId":"getCallabletimesetsCallabletimesetId","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallabletimesetsCallabletimesetId"},"put":{"tags":["Outbound"],"summary":"Update callable time set","description":"","operationId":"putCallabletimesetsCallabletimesetId","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DialerCallableTimeSet","required":false,"schema":{"$ref":"#/definitions/CallableTimeSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putCallabletimesetsCallabletimesetId"},"delete":{"tags":["Outbound"],"summary":"Delete callable time set","description":"","operationId":"deleteCallabletimesetsCallabletimesetId","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCallabletimesetsCallabletimesetId"}},"/api/v1/outbound/callanalysisresponsesets":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer call analysis response sets.","description":"","operationId":"getCallanalysisresponsesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"PREFIX","enum":["EQUALS","REGEX","CONTAINS","PREFIX","LESSTHAN","LESSTHANEQUALTO","GREATERTHAN","GREATERTHANEQUALTO","BEGINSWITH","ENDSWITH"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallanalysisresponsesets"},"post":{"tags":["Outbound"],"summary":"Create a dialer call analysis response set.","description":"","operationId":"postCallanalysisresponsesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ResponseSet","required":false,"schema":{"$ref":"#/definitions/ResponseSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallanalysisresponsesets"}},"/api/v1/outbound/callanalysisresponsesets/{callAnalysisSetId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer call analysis response set.","description":"","operationId":"getCallanalysisresponsesetsCallanalysissetId","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallanalysisresponsesetsCallanalysissetId"},"put":{"tags":["Outbound"],"summary":"Update a dialer call analysis response set.","description":"","operationId":"putCallanalysisresponsesetsCallanalysissetId","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ResponseSet","required":false,"schema":{"$ref":"#/definitions/ResponseSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putCallanalysisresponsesetsCallanalysissetId"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer call analysis response set.","description":"","operationId":"deleteCallanalysisresponsesetsCallanalysissetId","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCallanalysisresponsesetsCallanalysissetId"}},"/api/v1/outbound/campaigns":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer campaigns.","description":"","operationId":"getCampaigns","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"PREFIX","enum":["EQUALS","REGEX","CONTAINS","PREFIX","LESSTHAN","LESSTHANEQUALTO","GREATERTHAN","GREATERTHANEQUALTO","BEGINSWITH","ENDSWITH"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"contactListId","in":"query","description":"Contact List ID","required":false,"type":"string"},{"name":"dncListId","in":"query","description":"DNC list ID","required":false,"type":"string"},{"name":"distributionQueueId","in":"query","description":"Distribution queue ID","required":false,"type":"string"},{"name":"edgeGroupId","in":"query","description":"Edge group ID","required":false,"type":"string"},{"name":"callAnalysisResponseSetId","in":"query","description":"Call analysis response set ID","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCampaigns"},"post":{"tags":["Outbound"],"summary":"Create a campaign.","description":"","operationId":"postCampaigns","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Campaign","required":false,"schema":{"$ref":"#/definitions/Campaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCampaigns"}},"/api/v1/outbound/campaigns/progress":{"post":{"tags":["Outbound"],"summary":"Get progress for a list of campaigns","description":"","operationId":"postCampaignsProgress","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Campaign IDs","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignProgress"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCampaignsProgress"}},"/api/v1/outbound/campaigns/{campaignId}":{"get":{"tags":["Outbound"],"summary":"Get dialer campaign.","description":"","operationId":"getCampaignsCampaignId","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCampaignsCampaignId"},"put":{"tags":["Outbound"],"summary":"Update a campaign.","description":"","operationId":"putCampaignsCampaignId","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Campaign","required":false,"schema":{"$ref":"#/definitions/Campaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putCampaignsCampaignId"},"delete":{"tags":["Outbound"],"summary":"Delete a campaign.","description":"","operationId":"deleteCampaignsCampaignId","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCampaignsCampaignId"}},"/api/v1/outbound/campaigns/{campaignId}/agents/{userId}":{"put":{"tags":["Outbound"],"summary":"Send notification that an agent's state changed ","description":"New agent state.","operationId":"putCampaignsCampaignIdAgentsUserId","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"name":"userId","in":"path","description":"Agent's user ID","required":true,"type":"string"},{"in":"body","name":"body","description":"agent","required":false,"schema":{"$ref":"#/definitions/Agent"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putCampaignsCampaignIdAgentsUserId"}},"/api/v1/outbound/campaigns/{campaignId}/callback/schedule":{"post":{"tags":["Outbound"],"summary":"Schedule a Callback for a Dialer Campaign","description":"","operationId":"postCampaignsCampaignIdCallbackSchedule","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactCallbackRequest","required":false,"schema":{"$ref":"#/definitions/ContactCallbackRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactCallbackRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCampaignsCampaignIdCallbackSchedule"}},"/api/v1/outbound/campaigns/{campaignId}/diagnostics":{"get":{"tags":["Outbound"],"summary":"Get campaign diagnostics","description":"","operationId":"getCampaignsCampaignIdDiagnostics","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignDiagnostics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCampaignsCampaignIdDiagnostics"}},"/api/v1/outbound/campaigns/{campaignId}/progress":{"get":{"tags":["Outbound"],"summary":"Get campaign progress","description":"","operationId":"getCampaignsCampaignIdProgress","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignProgress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCampaignsCampaignIdProgress"},"delete":{"tags":["Outbound"],"summary":"Reset campaign progress and recycle the campaign","description":"","operationId":"deleteCampaignsCampaignIdProgress","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"202":{"description":"Accepted - the campaign will be recycled momentarily"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCampaignsCampaignIdProgress"}},"/api/v1/outbound/campaigns/{campaignId}/stats":{"get":{"tags":["Outbound"],"summary":"Get statistics about a Dialer Campaign","description":"","operationId":"getCampaignsCampaignIdStats","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignStats"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCampaignsCampaignIdStats"}},"/api/v1/outbound/contactlists":{"get":{"tags":["Outbound"],"summary":"Query a list of contact lists.","description":"","operationId":"getContactlists","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"importStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"PREFIX","enum":["EQUALS","REGEX","CONTAINS","PREFIX","LESSTHAN","LESSTHANEQUALTO","GREATERTHAN","GREATERTHANEQUALTO","BEGINSWITH","ENDSWITH"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContactlists"},"post":{"tags":["Outbound"],"summary":"Create a contact List.","description":"","operationId":"postContactlists","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ContactList","required":false,"schema":{"$ref":"#/definitions/ContactList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postContactlists"}},"/api/v1/outbound/contactlists/penetrationrates":{"post":{"tags":["Outbound"],"summary":"Get penetration rates for a list of penetration rate identifiers (contact list id and qualifier id)","description":"","operationId":"postContactlistsPenetrationrates","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"PenetrationRateIdentifierList","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/PenetrationRateId"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/PenetrationRate"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postContactlistsPenetrationrates"}},"/api/v1/outbound/contactlists/{contactListId}":{"get":{"tags":["Outbound"],"summary":"Get dialer contactList.","description":"","operationId":"getContactlistsContactlistId","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"importStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContactlistsContactlistId"},"put":{"tags":["Outbound"],"summary":"Update a contact list.","description":"","operationId":"putContactlistsContactlistId","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactList","required":false,"schema":{"$ref":"#/definitions/ContactList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putContactlistsContactlistId"},"delete":{"tags":["Outbound"],"summary":"Delete a contact list.","description":"","operationId":"deleteContactlistsContactlistId","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteContactlistsContactlistId"}},"/api/v1/outbound/contactlists/{contactListId}/contacts":{"post":{"tags":["Outbound"],"summary":"Add contacts to a contact list.","description":"","operationId":"postContactlistsContactlistIdContacts","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/Contact"}}},{"name":"priority","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Contact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postContactlistsContactlistIdContacts"}},"/api/v1/outbound/contactlists/{contactListId}/contacts/{contactId}":{"get":{"tags":["Outbound"],"summary":"Get dialer contactList.","description":"","operationId":"getContactlistsContactlistIdContactsContactId","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Contact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContactlistsContactlistIdContactsContactId"},"put":{"tags":["Outbound"],"summary":"Update a contact.","description":"","operationId":"putContactlistsContactlistIdContactsContactId","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact","required":false,"schema":{"$ref":"#/definitions/Contact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Contact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putContactlistsContactlistIdContactsContactId"},"delete":{"tags":["Outbound"],"summary":"Delete a contact.","description":"","operationId":"deleteContactlistsContactlistIdContactsContactId","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteContactlistsContactlistIdContactsContactId"}},"/api/v1/outbound/contactlists/{contactListId}/export":{"post":{"tags":["Outbound"],"summary":"Initiate the export of a contact list.","description":"Returns 200 if received OK.","operationId":"postContactlistsContactlistIdExport","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postContactlistsContactlistIdExport"}},"/api/v1/outbound/contactlists/{contactListId}/importstatus":{"get":{"tags":["Outbound"],"summary":"Get dialer contactList import status.","description":"","operationId":"getContactlistsContactlistIdImportstatus","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContactlistsContactlistIdImportstatus"}},"/api/v1/outbound/contactlists/{contactListId}/{campaignId}/penetrationrate":{"get":{"tags":["Outbound"],"summary":"Get Dialer campaign's penetration rate","description":"Get dialer campaign's penetration rate.","operationId":"getContactlistsContactlistIdCampaignIdPenetrationrate","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PenetrationRate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContactlistsContactlistIdCampaignIdPenetrationrate"}},"/api/v1/outbound/conversations/{conversationId}/dnc":{"post":{"tags":["Outbound"],"summary":"Add phone numbers to a Dialer DNC list.","description":"","operationId":"postConversationsConversationIdDnc","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationsConversationIdDnc"}},"/api/v1/outbound/dnclists":{"get":{"tags":["Outbound"],"summary":"Query dialer DNC lists","description":"","operationId":"getDnclists","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"importStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"PREFIX","enum":["EQUALS","REGEX","CONTAINS","PREFIX","LESSTHAN","LESSTHANEQUALTO","GREATERTHAN","GREATERTHANEQUALTO","BEGINSWITH","ENDSWITH"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncListEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDnclists"},"post":{"tags":["Outbound"],"summary":"Create dialer DNC list","description":"","operationId":"postDnclists","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"DncList","required":false,"schema":{"$ref":"#/definitions/DncList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDnclists"}},"/api/v1/outbound/dnclists/{dncListId}":{"get":{"tags":["Outbound"],"summary":"Get dialer DNC list","description":"","operationId":"getDnclistsDnclistId","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"importStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDnclistsDnclistId"},"put":{"tags":["Outbound"],"summary":"Update dialer DNC list","description":"","operationId":"putDnclistsDnclistId","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DncList","required":false,"schema":{"$ref":"#/definitions/DncList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putDnclistsDnclistId"},"delete":{"tags":["Outbound"],"summary":"Delete dialer DNC list","description":"","operationId":"deleteDnclistsDnclistId","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteDnclistsDnclistId"}},"/api/v1/outbound/dnclists/{dncListId}/export":{"post":{"tags":["Outbound"],"summary":"Initiate the export of a dnc list.","description":"Returns 200 if received OK.","operationId":"postDnclistsDnclistIdExport","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDnclistsDnclistIdExport"}},"/api/v1/outbound/dnclists/{dncListId}/importstatus":{"get":{"tags":["Outbound"],"summary":"Get dialer dncList import status.","description":"","operationId":"getDnclistsDnclistIdImportstatus","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDnclistsDnclistIdImportstatus"}},"/api/v1/outbound/dnclists/{dncListId}/phonenumbers":{"post":{"tags":["Outbound"],"summary":"Add phone numbers to a Dialer DNC list.","description":"","operationId":"postDnclistsDnclistIdPhonenumbers","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DNC Phone Numbers","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDnclistsDnclistIdPhonenumbers"}},"/api/v1/outbound/previews":{"get":{"tags":["Outbound"],"summary":"Get dialer preview for user","description":"","operationId":"getPreviews","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Preview"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPreviews"}},"/api/v1/outbound/previews/{previewId}":{"get":{"tags":["Outbound"],"summary":"Get dialer preview","description":"","operationId":"getPreviewsPreviewId","produces":["application/json"],"parameters":[{"name":"previewId","in":"path","description":"preview ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Preview"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPreviewsPreviewId"}},"/api/v1/outbound/previews/{previewId}/dispositioncall":{"post":{"tags":["Outbound"],"summary":"Disposition preview call","description":"","operationId":"postPreviewsPreviewIdDispositioncall","produces":["application/json"],"parameters":[{"name":"previewId","in":"path","description":"preview ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DialerDispositionCallCommand"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postPreviewsPreviewIdDispositioncall"}},"/api/v1/outbound/previews/{previewId}/placecall":{"post":{"tags":["Outbound"],"summary":"place preview call","description":"","operationId":"postPreviewsPreviewIdPlacecall","produces":["application/json"],"parameters":[{"name":"previewId","in":"path","description":"preview ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DialerPlaceCallCommand"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerCall"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postPreviewsPreviewIdPlacecall"}},"/api/v1/outbound/rulesets":{"get":{"tags":["Outbound"],"summary":"Query a list of Rule Sets.","description":"","operationId":"getRulesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"PREFIX","enum":["EQUALS","REGEX","CONTAINS","PREFIX","LESSTHAN","LESSTHANEQUALTO","GREATERTHAN","GREATERTHANEQUALTO","BEGINSWITH","ENDSWITH"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRulesets"},"post":{"tags":["Outbound"],"summary":"Create a Dialer Call Analysis Response Set.","description":"","operationId":"postRulesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"RuleSet","required":false,"schema":{"$ref":"#/definitions/RuleSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRulesets"}},"/api/v1/outbound/rulesets/{ruleSetId}":{"get":{"tags":["Outbound"],"summary":"Get a Rule Set by ID.","description":"","operationId":"getRulesetsRulesetId","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRulesetsRulesetId"},"put":{"tags":["Outbound"],"summary":"Update a RuleSet.","description":"","operationId":"putRulesetsRulesetId","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"RuleSet","required":false,"schema":{"$ref":"#/definitions/RuleSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRulesetsRulesetId"},"delete":{"tags":["Outbound"],"summary":"Delete a Rule set.","description":"","operationId":"deleteRulesetsRulesetId","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteRulesetsRulesetId"}},"/api/v1/outbound/schedules/campaigns":{"get":{"tags":["Outbound"],"summary":"Query for a list of dialer campaign schedules.","description":"","operationId":"getSchedulesCampaigns","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignSchedule"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchedulesCampaigns"}},"/api/v1/outbound/schedules/campaigns/{campaignId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer campaign schedule.","description":"","operationId":"getSchedulesCampaignsCampaignId","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchedulesCampaignsCampaignId"},"put":{"tags":["Outbound"],"summary":"Update a new campaign schedule.","description":"","operationId":"putSchedulesCampaignsCampaignId","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"CampaignSchedule","required":false,"schema":{"$ref":"#/definitions/CampaignSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSchedulesCampaignsCampaignId"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer campaign schedule.","description":"","operationId":"deleteSchedulesCampaignsCampaignId","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSchedulesCampaignsCampaignId"}},"/api/v1/outbound/schedules/sequences":{"get":{"tags":["Outbound"],"summary":"Query for a list of dialer sequence schedules.","description":"","operationId":"getSchedulesSequences","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/SequenceSchedule"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchedulesSequences"}},"/api/v1/outbound/schedules/sequences/{sequenceId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer sequence schedule.","description":"","operationId":"getSchedulesSequencesSequenceId","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SequenceSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchedulesSequencesSequenceId"},"put":{"tags":["Outbound"],"summary":"Update a new sequence schedule.","description":"","operationId":"putSchedulesSequencesSequenceId","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"SequenceSchedule","required":false,"schema":{"$ref":"#/definitions/SequenceSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SequenceSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSchedulesSequencesSequenceId"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer sequence schedule.","description":"","operationId":"deleteSchedulesSequencesSequenceId","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSchedulesSequencesSequenceId"}},"/api/v1/outbound/sequences":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer campaign sequences.","description":"","operationId":"getSequences","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"PREFIX","enum":["EQUALS","REGEX","CONTAINS","PREFIX","LESSTHAN","LESSTHANEQUALTO","GREATERTHAN","GREATERTHANEQUALTO","BEGINSWITH","ENDSWITH"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSequences"},"post":{"tags":["Outbound"],"summary":"Create a new campaign sequence.","description":"","operationId":"postSequences","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization","required":false,"schema":{"$ref":"#/definitions/CampaignSequence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSequences"}},"/api/v1/outbound/sequences/{sequenceId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer campaign sequence.","description":"","operationId":"getSequencesSequenceId","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSequencesSequenceId"},"put":{"tags":["Outbound"],"summary":"Update a new campaign sequence.","description":"","operationId":"putSequencesSequenceId","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization","required":false,"schema":{"$ref":"#/definitions/CampaignSequence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSequencesSequenceId"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer campaign sequence.","description":"","operationId":"deleteSequencesSequenceId","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSequencesSequenceId"}},"/api/v1/outbound/wrapupcodemappings":{"get":{"tags":["Outbound"],"summary":"Get the Dialer wrap up code mapping.","description":"","operationId":"getWrapupcodemappings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapUpCodeMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getWrapupcodemappings"},"put":{"tags":["Outbound"],"summary":"Update the Dialer wrap up code mapping.","description":"","operationId":"putWrapupcodemappings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"wrapUpCodeMapping","required":false,"schema":{"$ref":"#/definitions/WrapUpCodeMapping"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapUpCodeMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putWrapupcodemappings"}},"/api/v1/presencedefinitions":{"get":{"tags":["Presence"],"summary":"Get an Organization's list of Presences","description":"","operationId":"getPresencedefinitions","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPresencedefinitions"},"post":{"tags":["Presence"],"summary":"Create an OrganizationPresence","description":"","operationId":"postPresencedefinitions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The OrganizationPresence to create","required":true,"schema":{"$ref":"#/definitions/OrganizationPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postPresencedefinitions"}},"/api/v1/presencedefinitions/{presenceId}":{"get":{"tags":["Presence"],"summary":"Get an OrganizationPresence","description":"","operationId":"getPresenceId","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPresenceId"},"put":{"tags":["Presence"],"summary":"Update an OrganizationPresence","description":"","operationId":"putPresenceId","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The OrganizationPresence to update","required":true,"schema":{"$ref":"#/definitions/OrganizationPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putPresenceId"},"delete":{"tags":["Presence"],"summary":"Delete an OrganizationPresence","description":"","operationId":"deletePresenceId","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deletePresenceId"}},"/api/v1/quality/agents/activity":{"get":{"tags":["Quality"],"summary":"Gets a list of Agent Activities","description":"Including the number of evaluations and average evaluation score","operationId":"getAgentsActivity","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"startTime","in":"query","description":"Start time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"End time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required":false,"type":"string","format":"date-time"},{"name":"agentUserId","in":"query","description":"user id of agent requested","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"evaluatorUserId","in":"query","description":"user id of the evaluator","required":false,"type":"string"},{"name":"name","in":"query","description":"name","required":false,"type":"string"},{"name":"group","in":"query","description":"group id","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentActivityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getAgentsActivity"}},"/api/v1/quality/calibrations":{"get":{"tags":["Quality"],"summary":"Get the list of calibrations","description":"","operationId":"getCalibrations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"conversationId","in":"query","description":"conversation id","required":false,"type":"string"},{"name":"startTime","in":"query","description":"Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required":false,"type":"string","format":"date-time"},{"name":"calibratorId","in":"query","description":"user id of calibrator","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CalibrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCalibrations"},"post":{"tags":["Quality"],"summary":"Create a calibration","description":"","operationId":"postCalibrations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"calibration","required":false,"schema":{"$ref":"#/definitions/Calibration"}},{"name":"expand","in":"query","description":"calibratorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCalibrations"}},"/api/v1/quality/calibrations/{calibrationId}":{"get":{"tags":["Quality"],"summary":"Get a calibration by id.","description":"","operationId":"getCalibrationsCalibrationId","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"name":"calibratorId","in":"query","description":"calibratorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCalibrationsCalibrationId"},"put":{"tags":["Quality"],"summary":"Update a calibration to the specified calibration via PUT.  Editable fields include: evaluators, expertEvaluator, and scoringIndex","description":"","operationId":"putCalibrationsCalibrationId","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Calibration","required":false,"schema":{"$ref":"#/definitions/Calibration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putCalibrationsCalibrationId"},"delete":{"tags":["Quality"],"summary":"Delete a calibration by id.","description":"","operationId":"deleteCalibrationsCalibrationId","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"name":"calibratorId","in":"query","description":"calibratorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCalibrationsCalibrationId"}},"/api/v1/quality/conversations/{conversationId}/audits":{"get":{"tags":["Quality"],"summary":"Get audits for conversation or recording","description":"","operationId":"getConversationsConversationIdAudits","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"recordingId","in":"query","description":"id of the recording","required":false,"type":"string"},{"name":"entityType","in":"query","description":"entity type options: Recording, Calibration, Evaluation, Annotation","required":false,"type":"string","default":"RECORDING"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QualityAuditPage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationsConversationIdAudits"}},"/api/v1/quality/conversations/{conversationId}/evaluations":{"post":{"tags":["Quality"],"summary":"Create an evaluation","description":"","operationId":"postConversationsConversationIdEvaluations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","description":"evaluation","required":false,"schema":{"$ref":"#/definitions/Evaluation"}},{"name":"expand","in":"query","description":"evaluatorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Evaluation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationsConversationIdEvaluations"}},"/api/v1/quality/conversations/{conversationId}/evaluations/{evaluationId}":{"get":{"tags":["Quality"],"summary":"Get an evaluation","description":"","operationId":"getConversationsConversationIdEvaluationsEvaluationId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","required":true,"type":"string"},{"name":"evaluationId","in":"path","required":true,"type":"string"},{"name":"expand","in":"query","description":"agent, evaluator, evaluationForm","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Evaluation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationsConversationIdEvaluationsEvaluationId"},"put":{"tags":["Quality"],"summary":"Update an evaluation","description":"","operationId":"putConversationsConversationIdEvaluationsEvaluationId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","required":true,"type":"string"},{"name":"evaluationId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","description":"evaluation","required":false,"schema":{"$ref":"#/definitions/Evaluation"}},{"name":"expand","in":"query","description":"evaluatorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Evaluation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putConversationsConversationIdEvaluationsEvaluationId"},"delete":{"tags":["Quality"],"summary":"Delete an evaluation","description":"","operationId":"deleteConversationsConversationIdEvaluationsEvaluationId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","required":true,"type":"string"},{"name":"evaluationId","in":"path","required":true,"type":"string"},{"name":"expand","in":"query","description":"evaluatorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Evaluation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteConversationsConversationIdEvaluationsEvaluationId"}},"/api/v1/quality/evaluations/query":{"get":{"tags":["Quality"],"summary":"Queries Evaluations and returns a paged list","description":"Query params must include one of conversationId, evaluatorUserId, or agentUserId","operationId":"getEvaluationsQuery","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"conversationId","in":"query","description":"conversationId specified","required":false,"type":"string"},{"name":"agentUserId","in":"query","description":"user id of the agent","required":false,"type":"string"},{"name":"evaluatorUserId","in":"query","description":"evaluator user id","required":false,"type":"string"},{"name":"queueId","in":"query","description":"queue id","required":false,"type":"string"},{"name":"startTime","in":"query","description":"start time of the evaluation query","required":false,"type":"string"},{"name":"endTime","in":"query","description":"end time of the evaluation query","required":false,"type":"string"},{"name":"evaluationState","in":"query","description":"evaluation state options: Pending, InProgress, Finished","required":false,"type":"array","items":{"type":"string","enum":["PENDING","INPROGRESS","FINISHED"]},"collectionFormat":"multi"},{"name":"isReleased","in":"query","description":"the evaluation has been released","required":false,"type":"boolean"},{"name":"agentHasRead","in":"query","description":"agent has the evaluation","required":false,"type":"boolean"},{"name":"expandAnswerTotalScores","in":"query","description":"get the total scores for evaluations","required":false,"type":"boolean"},{"name":"maximum","in":"query","description":"maximum","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEvaluationsQuery"},"post":{"tags":["Quality"],"summary":"Query evaluations","description":"","operationId":"postEvaluationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":false,"schema":{"$ref":"#/definitions/EvaluationQueryRequest"}},{"name":"expand","in":"query","description":"evaluator,agent","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEvaluationsQuery"}},"/api/v1/quality/evaluations/scoring":{"post":{"tags":["Quality"],"summary":"Score evaluation","description":"","operationId":"postEvaluationsScoring","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"evaluationAndScoringSet","required":false,"schema":{"$ref":"#/definitions/EvaluationFormAndScoringSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationScoringSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEvaluationsScoring"}},"/api/v1/quality/evaluators/activity":{"get":{"tags":["Quality"],"summary":"Get an evaluator activity","description":"","operationId":"getEvaluatorsActivity","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"startTime","in":"query","description":"The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required":false,"type":"string","format":"date-time"},{"name":"name","in":"query","description":"Evaluator name","required":false,"type":"string"},{"name":"permission","in":"query","description":"permission strings","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"group","in":"query","description":"group id","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluatorActivityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEvaluatorsActivity"}},"/api/v1/quality/forms":{"get":{"tags":["Scripts"],"summary":"Get the list of evaluation forms","description":"","operationId":"getForms","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getForms"},"post":{"tags":["Scripts"],"summary":"Create an evaluation form.","description":"","operationId":"postForms","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postForms"}},"/api/v1/quality/forms/{formId}":{"get":{"tags":["Scripts"],"summary":"Get an evaluation form","description":"","operationId":"getFormsFormId","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFormsFormId"},"put":{"tags":["Scripts"],"summary":"Update an evaluation form.","description":"","operationId":"putFormsFormId","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putFormsFormId"},"delete":{"tags":["Scripts"],"summary":"Delete an evaluation form.","description":"","operationId":"deleteFormsFormId","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteFormsFormId"}},"/api/v1/quality/forms/{formId}/versions":{"get":{"tags":["Scripts"],"summary":"Gets all the revisions for a specific evaluation.","description":"","operationId":"getFormsFormIdVersions","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFormsFormIdVersions"}},"/api/v1/quality/publishedforms":{"get":{"tags":["Scripts"],"summary":"Get the published evaluation forms.","description":"","operationId":"getPublishedforms","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPublishedforms"},"post":{"tags":["Scripts"],"summary":"Publish an evaluation form.","description":"","operationId":"postPublishedforms","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postPublishedforms"}},"/api/v1/quality/publishedforms/{formId}":{"get":{"tags":["Scripts"],"summary":"Get the published evaluation forms.","description":"","operationId":"getPublishedformsFormId","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPublishedformsFormId"}},"/api/v1/recording/mediaretentionpolicies":{"get":{"tags":["Recording"],"summary":"Gets media retention policy list with query options to filter on name and enabled.","description":"for a less verbose response, add summary=true to this endpoint","operationId":"getMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"the policy name - used for filtering results in searches.","required":false,"type":"string"},{"name":"enabled","in":"query","description":"checks to see if policy is enabled - use enabled = true or enabled = false","required":false,"type":"boolean"},{"name":"summary","in":"query","description":"provides a less verbose response of policy lists.","required":false,"type":"boolean","default":false},{"name":"hasErrors","in":"query","description":"provides a way to fetch all policies with errors or policies that do not have errors","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PolicyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMediaretentionpolicies"},"post":{"tags":["Recording"],"summary":"Create media retention policy","description":"","operationId":"postMediaretentionpolicies","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Policy","required":false,"schema":{"$ref":"#/definitions/Policy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postMediaretentionpolicies"},"delete":{"tags":["Recording"],"summary":"Delete media retention policies","description":"Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.","operationId":"deleteMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"ids","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteMediaretentionpolicies"}},"/api/v1/recording/mediaretentionpolicies/{policyId}":{"get":{"tags":["Recording"],"summary":"Get a media retention policy","description":"","operationId":"getMediaretentionpoliciesPolicyId","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMediaretentionpoliciesPolicyId"},"put":{"tags":["Recording"],"summary":"Update a media retention policy","description":"","operationId":"putMediaretentionpoliciesPolicyId","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":false,"schema":{"$ref":"#/definitions/Policy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putMediaretentionpoliciesPolicyId"},"delete":{"tags":["Recording"],"summary":"Delete a media retention policy","description":"","operationId":"deleteMediaretentionpoliciesPolicyId","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteMediaretentionpoliciesPolicyId"},"patch":{"tags":["Recording"],"summary":"Patch a media retention policy","description":"","operationId":"patchMediaretentionpoliciesPolicyId","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":false,"schema":{"$ref":"#/definitions/Policy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchMediaretentionpoliciesPolicyId"}},"/api/v1/recording/settings":{"get":{"tags":["Recording"],"summary":"Get the Recording Settings for the Organization","description":"","operationId":"getSettings","produces":["application/json"],"parameters":[{"name":"createDefault","in":"query","description":"If no settings are found, a new one is created with default values","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSettings"},"put":{"tags":["Recording"],"summary":"Update the Recording Settings for the Organization","description":"","operationId":"putSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/RecordingSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSettings"}},"/api/v1/responsemanagement/libraries":{"get":{"tags":["Response Management"],"summary":"Gets a list of existing response libraries.","description":"","operationId":"getLibraries","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LibraryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLibraries"},"post":{"tags":["Response Management"],"summary":"Create a response library.","description":"","operationId":"postLibraries","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Library","required":false,"schema":{"$ref":"#/definitions/Library"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postLibraries"}},"/api/v1/responsemanagement/libraries/{libraryId}":{"get":{"tags":["Response Management"],"summary":"Get details about an existing response library.","description":"","operationId":"getLibrariesLibraryId","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLibrariesLibraryId"},"put":{"tags":["Response Management"],"summary":"Update an existing response library.","description":"Fields that can be updated: name. The most recent version is required for updates.","operationId":"putLibrariesLibraryId","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Library","required":false,"schema":{"$ref":"#/definitions/Library"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"409":{"description":"Resource conflict - Unexpected version was provided"},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putLibrariesLibraryId"},"delete":{"tags":["Response Management"],"summary":"Delete an existing response library.","description":"This will remove any responses associated with the library.","operationId":"deleteLibrariesLibraryId","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteLibrariesLibraryId"}},"/api/v1/responsemanagement/responses":{"get":{"tags":["Response Management"],"summary":"Gets a list of existing responses.","description":"","operationId":"getResponses","produces":["application/json"],"parameters":[{"name":"libraryId","in":"query","description":"Library ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getResponses"},"post":{"tags":["Response Management"],"summary":"Create a response.","description":"","operationId":"postResponses","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Response","required":false,"schema":{"$ref":"#/definitions/Response"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postResponses"}},"/api/v1/responsemanagement/responses/query":{"post":{"tags":["Response Management"],"summary":"Query responses","description":"","operationId":"postResponsesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Response","required":false,"schema":{"$ref":"#/definitions/ResponseQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseQueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postResponsesQuery"}},"/api/v1/responsemanagement/responses/{responseId}":{"get":{"tags":["Response Management"],"summary":"Get details about an existing response.","description":"","operationId":"getResponsesResponseId","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getResponsesResponseId"},"put":{"tags":["Response Management"],"summary":"Update an existing response.","description":"Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.","operationId":"putResponsesResponseId","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Response","required":false,"schema":{"$ref":"#/definitions/Response"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"409":{"description":"Resource conflict - Unexpected version was provided"},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putResponsesResponseId"},"delete":{"tags":["Response Management"],"summary":"Delete an existing response.","description":"This will remove the response from any libraries associated with it.","operationId":"deleteResponsesResponseId","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteResponsesResponseId"}},"/api/v1/routing/email/domains":{"get":{"tags":["Routing"],"summary":"Get domains","description":"","operationId":"getEmailDomains","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailDomains"},"post":{"tags":["Routing"],"summary":"Create a domain","description":"","operationId":"postEmailDomains","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Domain","required":false,"schema":{"$ref":"#/definitions/InboundDomain"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEmailDomains"}},"/api/v1/routing/email/domains/{domain}/routes":{"get":{"tags":["Routing"],"summary":"Get routes","description":"","operationId":"getEmailDomainsDomainRoutes","produces":["application/json"],"parameters":[{"name":"domain","in":"path","description":"email domain","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRouteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailDomainsDomainRoutes"},"post":{"tags":["Routing"],"summary":"Create a route","description":"","operationId":"postEmailDomainsDomainRoutes","produces":["application/json"],"parameters":[{"name":"domain","in":"path","description":"email domain","required":true,"type":"string"},{"in":"body","name":"body","description":"Route","required":false,"schema":{"$ref":"#/definitions/InboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEmailDomainsDomainRoutes"}},"/api/v1/routing/email/domains/{domain}/routes/{id}":{"get":{"tags":["Routing"],"summary":"Get a route","description":"","operationId":"getEmailDomainsDomainRoutesId","produces":["application/json"],"parameters":[{"name":"domain","in":"path","description":"email domain","required":true,"type":"string"},{"name":"id","in":"path","description":"route ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailDomainsDomainRoutesId"},"put":{"tags":["Routing"],"summary":"Update a route","description":"","operationId":"putEmailDomainsDomainRoutesId","produces":["application/json"],"parameters":[{"name":"domain","in":"path","description":"email domain","required":true,"type":"string"},{"name":"id","in":"path","description":"route ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Route","required":false,"schema":{"$ref":"#/definitions/InboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putEmailDomainsDomainRoutesId"},"delete":{"tags":["Routing"],"summary":"Delete a route","description":"","operationId":"deleteEmailDomainsDomainRoutesId","produces":["application/json"],"parameters":[{"name":"domain","in":"path","description":"email domain","required":true,"type":"string"},{"name":"id","in":"path","description":"route ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteEmailDomainsDomainRoutesId"}},"/api/v1/routing/email/domains/{id}":{"delete":{"tags":["Routing"],"summary":"Delete a domain","description":"","operationId":"deleteEmailDomainsId","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteEmailDomainsId"}},"/api/v1/routing/email/setup":{"get":{"tags":["Routing"],"summary":"Get email setup","description":"","operationId":"getEmailSetup","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailSetup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailSetup"}},"/api/v1/routing/queues":{"get":{"tags":["Routing"],"summary":"Get list of queues.","description":"","operationId":"getQueues","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"active","in":"query","description":"Active","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getQueues"},"post":{"tags":["Routing"],"summary":"Create queue","description":"","operationId":"postQueues","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Queue","required":false,"schema":{"$ref":"#/definitions/Queue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQueues"}},"/api/v1/routing/queues/{queueId}":{"get":{"tags":["Routing"],"summary":"Get details about this queue.","description":"","operationId":"getQueuesQueueId","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getQueuesQueueId"},"put":{"tags":["Routing"],"summary":"Update a queue","description":"","operationId":"putQueuesQueueId","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue","required":false,"schema":{"$ref":"#/definitions/Queue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putQueuesQueueId"},"delete":{"tags":["Routing"],"summary":"Delete a queue","description":"","operationId":"deleteQueuesQueueId","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"forceDelete","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteQueuesQueueId"}},"/api/v1/routing/queues/{queueId}/estimatedwaittime":{"get":{"tags":["Routing"],"summary":"Get Estimated Wait Time","description":"","operationId":"getQueuesQueueIdEstimatedwaittime","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"queueId","required":true,"type":"string"},{"name":"conversationId","in":"query","description":"conversationId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EstimatedWaitTimePredictions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getQueuesQueueIdEstimatedwaittime"}},"/api/v1/routing/queues/{queueId}/members":{"get":{"tags":["Routing"],"summary":"Get members in a queue","description":"Get the list of members of a queue","operationId":"getQueuesQueueIdMembers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"userId","in":"query","description":"UserID","required":false,"type":"string"},{"name":"statusId","in":"query","description":"Status ID","required":false,"type":"string"},{"name":"joined","in":"query","description":"Joined","required":false,"type":"boolean"},{"name":"expand","in":"query","description":"expand","required":false,"type":"string","enum":["routingStatus"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getQueuesQueueIdMembers"}},"/api/v1/routing/queues/{queueId}/members/{memberId}":{"put":{"tags":["Routing"],"summary":"Join or unjoin a user to the queue.","description":"","operationId":"putQueuesQueueIdMembersMemberId","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member/User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"To join queue ~ \"joined\":true","required":false,"schema":{"$ref":"#/definitions/QueueMember"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putQueuesQueueIdMembersMemberId"}},"/api/v1/routing/queues/{queueId}/users":{"get":{"tags":["Routing"],"summary":"Get the members of this queue","description":"","operationId":"getQueuesQueueIdUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"expand","in":"query","description":"expand","required":false,"type":"string"},{"name":"directMembers","in":"query","description":"Only get users that are direct members of the queue","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getQueuesQueueIdUsers"},"post":{"tags":["Routing"],"summary":"Bulk add or delete up to 100 queue members","description":"","operationId":"postQueuesQueueIdUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}}},{"name":"delete","in":"query","description":"True to delete queue members","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQueuesQueueIdUsers"},"patch":{"tags":["Routing"],"summary":"Join or unjoin a set of users for a queue","description":"","operationId":"patchQueuesQueueIdUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchQueuesQueueIdUsers"}},"/api/v1/routing/queues/{queueId}/users/{memberId}":{"delete":{"tags":["Routing"],"summary":"Delete queue member","description":"","operationId":"deleteQueuesQueueIdUsersMemberId","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteQueuesQueueIdUsersMemberId"},"patch":{"tags":["Routing"],"summary":"Update the ring number of joined status for a User in a Queue","description":"","operationId":"patchQueuesQueueIdUsersMemberId","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Member","required":false,"schema":{"$ref":"#/definitions/QueueMember"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMember"}},"202":{"description":"User ring number change has been accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchQueuesQueueIdUsersMemberId"}},"/api/v1/routing/queues/{queueId}/wrapupcodes":{"get":{"tags":["Routing"],"summary":"Get the wrap-up codes for a queue","description":"","operationId":"getQueuesQueueIdWrapupcodes","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"codeId","in":"path","description":"Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getQueuesQueueIdWrapupcodes"},"post":{"tags":["Routing"],"summary":"Add up to 100 wrap-up codes to a queue","description":"","operationId":"postQueuesQueueIdWrapupcodes","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"codeId","in":"path","description":"Code ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQueuesQueueIdWrapupcodes"}},"/api/v1/routing/queues/{queueId}/wrapupcodes/{codeId}":{"delete":{"tags":["Routing"],"summary":"Delete a wrap-up code from a queue","description":"","operationId":"deleteQueuesQueueIdWrapupcodesCodeId","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"codeId","in":"path","description":"Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteQueuesQueueIdWrapupcodesCodeId"}},"/api/v1/routing/skills":{"get":{"tags":["Routing"],"summary":"Get the list of skills.","description":"","operationId":"getSkills","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSkills"}},"/api/v1/routing/utilization":{"get":{"tags":["Routing"],"summary":"Get the utilization settings.","description":"","operationId":"getUtilization","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Utilization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUtilization"},"put":{"tags":["Routing"],"summary":"Update the utilization settings.","description":"","operationId":"putUtilization","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"utilization","required":false,"schema":{"$ref":"#/definitions/Utilization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Utilization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUtilization"},"delete":{"tags":["Routing"],"summary":"Delete utilization settings and revert to system defaults.","description":"","operationId":"deleteUtilization","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteUtilization"}},"/api/v1/routing/wrapupcodes":{"get":{"tags":["Routing"],"summary":"Get list of wrapup codes.","description":"","operationId":"getWrapupcodes","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCodeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getWrapupcodes"},"post":{"tags":["Routing"],"summary":"Create a wrap-up code","description":"","operationId":"postWrapupcodes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"WrapupCode","required":false,"schema":{"$ref":"#/definitions/WrapupCode"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postWrapupcodes"}},"/api/v1/routing/wrapupcodes/{codeId}":{"get":{"tags":["Routing"],"summary":"Get details about this wrap-up code.","description":"","operationId":"getWrapupcodesCodeId","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getWrapupcodesCodeId"},"put":{"tags":["Routing"],"summary":"Update wrap-up code","description":"","operationId":"putWrapupcodesCodeId","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"},{"in":"body","name":"body","description":"WrapupCode","required":false,"schema":{"$ref":"#/definitions/WrapupCode"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putWrapupcodesCodeId"},"delete":{"tags":["Routing"],"summary":"Delete wrap-up code","description":"","operationId":"deleteWrapupcodesCodeId","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteWrapupcodesCodeId"}},"/api/v1/scripts":{"get":{"tags":["Scripts"],"summary":"Get the list of scripts","description":"","operationId":"getScripts","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"feature","in":"query","description":"Feature","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScriptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getScripts"},"post":{"tags":["Scripts"],"summary":"Create a script.","description":"","operationId":"postScripts","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Script"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postScripts"}},"/api/v1/search/chats":{"post":{"tags":["Search"],"summary":"Search chat history","description":"","operationId":"postChats","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":false,"schema":{"$ref":"#/definitions/ChatSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSearchListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postChats"}},"/api/v1/stations":{"get":{"tags":["Stations"],"summary":"Get the list of available stations.","description":"","operationId":"getStations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getStations"}},"/api/v1/stations/{id}":{"get":{"tags":["Stations"],"summary":"Get station.","description":"","operationId":"getId","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Station ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Station"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getId"}},"/api/v1/stations/{id}/associateduser":{"delete":{"tags":["Stations"],"summary":"Unassigns the user assigned to this station","description":"","operationId":"deleteIdAssociateduser","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Station ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteIdAssociateduser"}},"/api/v1/telephony/providers/edge/edgegroups":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of edge groups.","description":"","operationId":"getProvidersEdgeEdgegroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeEdgegroups"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge group.","description":"","operationId":"postProvidersEdgeEdgegroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"EdgeGroup","required":false,"schema":{"$ref":"#/definitions/EdgeGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgeEdgegroups"}},"/api/v1/telephony/providers/edge/edgegroups/{edgeGroupId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge group.","description":"","operationId":"getProvidersEdgeEdgegroupsEdgegroupId","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeEdgegroupsEdgegroupId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an edge group.","description":"","operationId":"putProvidersEdgeEdgegroupsEdgegroupId","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EdgeGroup","required":false,"schema":{"$ref":"#/definitions/EdgeGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgeEdgegroupsEdgegroupId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an edge group.","description":"","operationId":"deleteProvidersEdgeEdgegroupsEdgegroupId","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgeEdgegroupsEdgegroupId"}},"/api/v1/telephony/providers/edge/linebasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of line base settings objects","description":"","operationId":"getProvidersEdgeLinebasesettings","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeLinebasesettings"}},"/api/v1/telephony/providers/edge/linebasesettings/{lineBaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a line base settings object by ID","description":"","operationId":"getProvidersEdgeLinebasesettingsLinebaseId","produces":["application/json"],"parameters":[{"name":"lineBaseId","in":"path","description":"Line base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeLinebasesettingsLinebaseId"}},"/api/v1/telephony/providers/edge/lines":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Lines","description":"","operationId":"getProvidersEdgeLines","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties","site","edgeGroup","primaryEdge","secondaryEdge","edges","assignedUser"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeLines"}},"/api/v1/telephony/providers/edge/lines/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance","description":"","operationId":"getProvidersEdgeLinesTemplate","produces":["application/json"],"parameters":[{"name":"lineBaseSettingsId","in":"query","description":"The id of a Line Base Settings object upon which to base this Line","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Line"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeLinesTemplate"}},"/api/v1/telephony/providers/edge/lines/{lineId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Line by ID","description":"","operationId":"getProvidersEdgeLinesLineId","produces":["application/json"],"parameters":[{"name":"lineId","in":"path","description":"Line ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Line"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeLinesLineId"}},"/api/v1/telephony/providers/edge/outboundroutes":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get outbound routes","description":"","operationId":"getProvidersEdgeOutboundroutes","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"site.id","in":"query","description":"Filter by site.id","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeOutboundroutes"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create outbound rule","description":"","operationId":"postProvidersEdgeOutboundroutes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"OutboundRoute","required":false,"schema":{"$ref":"#/definitions/OutboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgeOutboundroutes"}},"/api/v1/telephony/providers/edge/outboundroutes/{outboundRouteId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get outbound route","description":"","operationId":"getProvidersEdgeOutboundroutesOutboundrouteId","produces":["application/json"],"parameters":[{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeOutboundroutesOutboundrouteId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update outbound route","description":"","operationId":"putProvidersEdgeOutboundroutesOutboundrouteId","produces":["application/json"],"parameters":[{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"},{"in":"body","name":"body","description":"OutboundRoute","required":false,"schema":{"$ref":"#/definitions/OutboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgeOutboundroutesOutboundrouteId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete Outbound Route","description":"","operationId":"deleteProvidersEdgeOutboundroutesOutboundrouteId","produces":["application/json"],"parameters":[{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgeOutboundroutesOutboundrouteId"}},"/api/v1/telephony/providers/edge/phonebasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Phone Base Settings objects","description":"","operationId":"getProvidersEdgePhonebasesettings","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgePhonebasesettings"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new Phone Base Settings object","description":"","operationId":"postProvidersEdgePhonebasesettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PhoneBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgePhonebasesettings"}},"/api/v1/telephony/providers/edge/phonebasesettings/availablemetabases":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of available makes and models to create a new Phone Base Settings","description":"","operationId":"getProvidersEdgePhonebasesettingsAvailablemetabases","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneMetaBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgePhonebasesettingsAvailablemetabases"}},"/api/v1/telephony/providers/edge/phonebasesettings/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance","description":"","operationId":"getProvidersEdgePhonebasesettingsTemplate","produces":["application/json"],"parameters":[{"name":"phoneMetabaseId","in":"query","description":"The id of a metabase object upon which to base this Phone Base Settings","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgePhonebasesettingsTemplate"}},"/api/v1/telephony/providers/edge/phonebasesettings/{phoneBaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone Base Settings object by ID","description":"","operationId":"getProvidersEdgePhonebasesettingsPhonebaseId","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgePhonebasesettingsPhonebaseId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Phone Base Settings by ID","description":"","operationId":"putProvidersEdgePhonebasesettingsPhonebaseId","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PhoneBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgePhonebasesettingsPhonebaseId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Phone Base Settings by ID","description":"","operationId":"deleteProvidersEdgePhonebasesettingsPhonebaseId","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgePhonebasesettingsPhonebaseId"}},"/api/v1/telephony/providers/edge/phones":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Phone Instances","description":"","operationId":"getProvidersEdgePhones","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"site.id","in":"query","description":"Filter by site.id","required":false,"type":"string"},{"name":"phoneBaseSettings.id","in":"query","description":"Filter by phoneBaseSettings.id","required":false,"type":"string"},{"name":"phone_hardwareId","in":"query","description":"Filter by phone_hardwareId","required":false,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties","site","edgeGroup","status","status.primaryEdgesStatus","status.secondaryEdgesStatus","phoneBaseSettings","lines"]},"collectionFormat":"multi"},{"name":"fields","in":"query","description":"Fields under properties to get, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties.*"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgePhones"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new Phone","description":"","operationId":"postProvidersEdgePhones","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Phone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgePhones"}},"/api/v1/telephony/providers/edge/phones/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot Multiple Phones","description":"","operationId":"postProvidersEdgePhonesReboot","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/PhonesReboot"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgePhonesReboot"}},"/api/v1/telephony/providers/edge/phones/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance","description":"","operationId":"getProvidersEdgePhonesTemplate","produces":["application/json"],"parameters":[{"name":"phoneBaseSettingsId","in":"query","description":"The id of a Phone Base Settings object upon which to base this Phone","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgePhonesTemplate"}},"/api/v1/telephony/providers/edge/phones/{phoneId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone by ID","description":"","operationId":"getProvidersEdgePhonesPhoneId","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgePhonesPhoneId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Phone by ID","description":"","operationId":"putProvidersEdgePhonesPhoneId","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Phone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgePhonesPhoneId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Phone by ID","description":"","operationId":"deleteProvidersEdgePhonesPhoneId","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgePhonesPhoneId"}},"/api/v1/telephony/providers/edge/phones/{phoneId}/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot a Phone","description":"","operationId":"postProvidersEdgePhonesPhoneIdReboot","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone Id","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgePhonesPhoneIdReboot"}},"/api/v1/telephony/providers/edge/timezones":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Edge-compatible time zones","description":"","operationId":"getProvidersEdgeTimezones","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":1000,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeZoneEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeTimezones"}},"/api/v1/telephony/providers/edge/trunkbasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get Trunk Base Settings listing","description":"","operationId":"getProvidersEdgeTrunkbasesettings","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeTrunkbasesettings"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a Trunk Base Settings object","description":"","operationId":"postProvidersEdgeTrunkbasesettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TrunkBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgeTrunkbasesettings"}},"/api/v1/telephony/providers/edge/trunkbasesettings/availablemetabases":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of available makes and models to create a new Trunk Base Settings","description":"","operationId":"getProvidersEdgeTrunkbasesettingsAvailablemetabases","produces":["application/json"],"parameters":[{"name":"type","in":"query","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"]},{"name":"pageSize","in":"query","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkMetabaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeTrunkbasesettingsAvailablemetabases"}},"/api/v1/telephony/providers/edge/trunkbasesettings/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance","description":"","operationId":"getProvidersEdgeTrunkbasesettingsTemplate","produces":["application/json"],"parameters":[{"name":"trunkMetabaseId","in":"query","description":"The id of a metabase object upon which to base this Trunk Base Settings","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeTrunkbasesettingsTemplate"}},"/api/v1/telephony/providers/edge/trunkbasesettings/{trunkBaseSettingsId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk Base Settings object by ID","description":"","operationId":"getProvidersEdgeTrunkbasesettingsTrunkbasesettingsId","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeTrunkbasesettingsTrunkbasesettingsId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Trunk Base Settings object by ID","description":"","operationId":"putProvidersEdgeTrunkbasesettingsTrunkbasesettingsId","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TrunkBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgeTrunkbasesettingsTrunkbasesettingsId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Trunk Base Settings object by ID","description":"","operationId":"deleteProvidersEdgeTrunkbasesettingsTrunkbasesettingsId","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgeTrunkbasesettingsTrunkbasesettingsId"}},"/api/v1/timezones":{"get":{"tags":["Utilities"],"summary":"Get time zones list","description":"","operationId":"getTimezones","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeZoneEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getTimezones"}},"/api/v1/tokens/me":{"delete":{"tags":["Tokens"],"summary":"Delete  auth token used to make the request.","description":"","operationId":"deleteMe","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteMe"}},"/api/v1/userrecordings":{"get":{"tags":["User Recordings"],"summary":"Get a list of user recordings.","description":"","operationId":"getUserrecordings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"conversation","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRecordingEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserrecordings"}},"/api/v1/userrecordings/summary":{"get":{"tags":["User Recordings"],"summary":"Get user recording summary","description":"","operationId":"getSummary","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxSummary"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSummary"}},"/api/v1/userrecordings/{recordingId}":{"get":{"tags":["User Recordings"],"summary":"Get a user recording.","description":"","operationId":"getRecordingId","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"conversation","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRecordingId"},"put":{"tags":["User Recordings"],"summary":"Update a user recording.","description":"","operationId":"putRecordingId","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"},{"in":"body","name":"body","description":"UserRecording","required":false,"schema":{"$ref":"#/definitions/UserRecording"}},{"name":"expand","in":"query","description":"conversation","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRecordingId"},"delete":{"tags":["User Recordings"],"summary":"Delete a user recording.","description":"","operationId":"deleteRecordingId","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteRecordingId"}},"/api/v1/userrecordings/{recordingId}/media":{"get":{"tags":["User Recordings"],"summary":"Download a user recording.","description":"","operationId":"getRecordingIdMedia","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired format (WEBM, WAV, etc.)","required":false,"type":"string","default":"WEBM","enum":["WEBM","WAV"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DownloadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRecordingIdMedia"}},"/api/v1/users":{"get":{"tags":["Users"],"summary":"Get the list of available users.","description":"","operationId":"getUsers","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"role","in":"query","description":"Role","required":false,"type":"string"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"username","in":"query","description":"Username","required":false,"type":"string"},{"name":"skill","in":"query","description":"Skill","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["[routingStatus","primaryPresence","conversationSummary","outOfOffice","geolocation]"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUsers"},"post":{"tags":["Users"],"summary":"Create a configuration service user.","description":"","operationId":"postUsers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"User","required":false,"schema":{"$ref":"#/definitions/User"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postUsers"}},"/api/v1/users/me":{"get":{"tags":["Users"],"summary":"Get user.","description":"","operationId":"getMe","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["[routingStatus","primaryPresence","conversationSummary","geolocation]"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMe"}},"/api/v1/users/{userId}":{"get":{"tags":["Users"],"summary":"Get user.","description":"","operationId":"getUserId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["[routingStatus","primaryPresence","conversationSummary","outOfOffice","geolocation]"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserId"},"put":{"tags":["Users"],"summary":"Set user station","description":"","operationId":"putUserId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"stationUri","required":true,"schema":{"$ref":"#/definitions/User"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserId"}},"/api/v1/users/{userId}/callforwarding":{"get":{"tags":["Users"],"summary":"Get a user's CallForwarding","description":"","operationId":"getUserIdCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdCallforwarding"},"put":{"tags":["Users"],"summary":"Update a user's CallForwarding","description":"","operationId":"putUserIdCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CallForwarding"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdCallforwarding"},"patch":{"tags":["Users"],"summary":"Patch a user's CallForwarding","description":"","operationId":"patchUserIdCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CallForwarding"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserIdCallforwarding"}},"/api/v1/users/{userId}/geolocations/{clientId}":{"get":{"tags":["Geolocation","Users"],"summary":"Get a user's Geolocation","description":"","operationId":"getUserIdGeolocationsClientId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"clientId","in":"path","description":"client Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Geolocation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdGeolocationsClientId"},"patch":{"tags":["Geolocation","Users"],"summary":"Patch a user's Geolocation","description":"The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source.  Option 2: Provide the 'latitude' and 'longitude' values.  This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'.  Option 3:  Provide the 'city', 'region', 'country' values.  Option 1 can be combined with Option 2 or Option 3.  For example, update the client as primary and provide latitude and longitude values.","operationId":"patchUserIdGeolocationsClientId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"clientId","in":"path","description":"client Id","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Geolocation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Geolocation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserIdGeolocationsClientId"}},"/api/v1/users/{userId}/greetings":{"get":{"tags":["Greetings"],"summary":"Get a list of the User's Greetings","description":"","operationId":"getUserIdGreetings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdGreetings"},"post":{"tags":["Greetings"],"summary":"Creates a Greeting for a User","description":"","operationId":"postUserIdGreetings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The Greeting to create","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postUserIdGreetings"}},"/api/v1/users/{userId}/greetings/defaults":{"get":{"tags":["Greetings"],"summary":"Grabs the list of Default Greetings given a User's ID","description":"","operationId":"getUserIdGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdGreetingsDefaults"},"put":{"tags":["Greetings"],"summary":"Updates the DefaultGreetingList of the specified User","description":"","operationId":"putUserIdGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated defaultGreetingList","required":true,"schema":{"$ref":"#/definitions/DefaultGreetingList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdGreetingsDefaults"}},"/api/v1/users/{userId}/outofoffice":{"get":{"tags":["Users"],"summary":"Get a OutOfOffice","description":"","operationId":"getUserIdOutofoffice","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutOfOffice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdOutofoffice"},"put":{"tags":["Users"],"summary":"Update an OutOfOffice","description":"","operationId":"putUserIdOutofoffice","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated UserPresence","required":true,"schema":{"$ref":"#/definitions/OutOfOffice"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutOfOffice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdOutofoffice"}},"/api/v1/users/{userId}/presences":{"get":{"tags":["Presence"],"summary":"Get an User's list of Presences","description":"","operationId":"getUserIdPresences","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdPresences"}},"/api/v1/users/{userId}/presences/{source}":{"get":{"tags":["Presence"],"summary":"Get a UserPresence","description":"","operationId":"getUserIdPresencesSource","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"source","in":"path","description":"Source","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdPresencesSource"},"put":{"tags":["Presence"],"summary":"Update a UserPresence","description":"","operationId":"putUserIdPresencesSource","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"source","in":"path","description":"Source","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated UserPresence","required":true,"schema":{"$ref":"#/definitions/UserPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdPresencesSource"},"patch":{"tags":["Presence"],"summary":"Patch a UserPresence","description":"","operationId":"patchUserIdPresencesSource","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"source","in":"path","description":"Source","required":true,"type":"string"},{"in":"body","name":"body","description":"The patched UserPresence","required":true,"schema":{"$ref":"#/definitions/UserPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserIdPresencesSource"}},"/api/v1/users/{userId}/primarypresence":{"get":{"tags":["Presence"],"summary":"Get a user's Primary UserPresence","description":"","operationId":"getUserIdPrimarypresence","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdPrimarypresence"}},"/api/v1/users/{userId}/primarypresencesource":{"get":{"tags":["Users"],"summary":"Get a user's PrimaryUserPresenceSource","description":"","operationId":"getUserIdPrimarypresencesource","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PrimaryUserPresenceSource"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdPrimarypresencesource"},"put":{"tags":["Users"],"summary":"Update a user's PrimaryUserPresenceSource","description":"","operationId":"putUserIdPrimarypresencesource","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PrimaryUserPresenceSource"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PrimaryUserPresenceSource"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdPrimarypresencesource"}},"/api/v1/users/{userId}/queues":{"get":{"tags":["Users"],"summary":"Get queues for user","description":"","operationId":"getUserIdQueues","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdQueues"},"patch":{"tags":["Users"],"summary":"Join or unjoin a set of queues for a user","description":"","operationId":"patchUserIdQueues","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"User Queues","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/UserQueue"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserIdQueues"}},"/api/v1/users/{userId}/queues/{queueId}":{"patch":{"tags":["Users"],"summary":"Join or unjoin a queue for a user","description":"","operationId":"patchUserIdQueuesQueueId","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Member","required":false,"schema":{"$ref":"#/definitions/UserQueue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserIdQueuesQueueId"}},"/api/v1/users/{userId}/roles":{"get":{"tags":["Users"],"summary":"List roles for user","description":"","operationId":"getUserIdRoles","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationRole"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdRoles"}},"/api/v1/users/{userId}/routingstatus":{"get":{"tags":["Users"],"summary":"Fetch the routing status of a user","description":"","operationId":"getUserIdRoutingstatus","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdRoutingstatus"},"put":{"tags":["Users"],"summary":"Update the routing status of a user","description":"","operationId":"putUserIdRoutingstatus","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Routing Status","required":false,"schema":{"$ref":"#/definitions/RoutingStatus"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdRoutingstatus"}},"/api/v1/users/{userId}/skills":{"get":{"tags":["Users"],"summary":"List skills for user","description":"","operationId":"getUserIdSkills","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserSkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdSkills"}},"/api/v1/voicemail/mailbox":{"get":{"tags":["Voicemail"],"summary":"Get mailbox information","description":"","operationId":"getMailbox","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMailboxInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMailbox"}},"/api/v1/voicemail/messages":{"get":{"tags":["Voicemail"],"summary":"List voicemail messages","description":"","operationId":"getMessages","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMessages"},"delete":{"tags":["Voicemail"],"summary":"Delete all voicemail messages","description":"","operationId":"deleteMessages","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteMessages"}},"/api/v1/voicemail/messages/{messageId}":{"get":{"tags":["Voicemail"],"summary":"Get message.","description":"","operationId":"getMessagesMessageId","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMessagesMessageId"},"put":{"tags":["Voicemail"],"summary":"Update a message.","description":"","operationId":"putMessagesMessageId","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"},{"in":"body","name":"body","description":"VoicemailMessage","required":false,"schema":{"$ref":"#/definitions/VoicemailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putMessagesMessageId"},"delete":{"tags":["Voicemail"],"summary":"Delete a message.","description":"","operationId":"deleteMessagesMessageId","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteMessagesMessageId"}},"/api/v1/voicemail/messages/{messageId}/media":{"get":{"tags":["Voicemail"],"summary":"Get media playback URI for this message","description":"","operationId":"getMessagesMessageIdMedia","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired format (WEBM, WAV, etc.)","required":false,"type":"string","default":"WEBM","enum":["WEBM","WAV"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMediaInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMessagesMessageIdMedia"}}},"securityDefinitions":{"PureCloud Auth":{"type":"oauth2","authorizationUrl":"https://auth.us-east-1.mypurecloud.com/authorize","flow":"implicit","scopes":{"all":"All the scopes"}}},"definitions":{"Entity":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}},"UserAuthorization":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"licenses":{"type":"array","items":{"type":"string"}},"roles":{"type":"array","items":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"permissionPolicies":{"type":"array","items":{"$ref":"#/definitions/ResourcePermissionPolicy"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrganizationAddress":{"type":"object","properties":{"display":{"type":"string"},"address":{"type":"string"},"type":{"type":"string","enum":["WORK","HOME","MOBILE","MAIN"]},"mediaType":{"type":"string","enum":["PHONE","EMAIL","SMS"]}}},"Product":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","AVAILABLE","NOT_AVAILABLE","PARTIAL"]},"comments":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeLogsJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"The created job id."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateShareRequest":{"type":"object","properties":{"sharedEntityType":{"type":"string","enum":["DOCUMENT"]},"sharedEntity":{"$ref":"#/definitions/Entity"},"memberType":{"type":"string","enum":["USER","PUBLIC"]},"member":{"$ref":"#/definitions/Entity"},"members":{"type":"array","items":{"$ref":"#/definitions/CreateShareRequestMember"}}}},"XlsxSchema":{"type":"object","required":["Name","SheetSchemas"],"properties":{"SheetSchemas":{"type":"array","description":"A list of all the schemas for a XLSX file. Each schema represents a different sheet's schema.","items":{"$ref":"#/definitions/SheetSchema"}},"Name":{"type":"string","description":"Human readable name for schema."},"CarrierId":{"type":"string","description":"Carrier ID associated with this CSV schema.","readOnly":true}}},"WorkItem":{"type":"object","required":["workItemConfigId","workItemExecId"],"properties":{"workItemExecId":{"type":"string","description":"The work item execution id."},"workItemConfigId":{"type":"string","description":"The work item definition id."},"workItemName":{"type":"string","description":"The work item displayable name."}},"description":"Information about the work item associated with a history item."},"PINConfiguration":{"type":"object","properties":{"minimumLength":{"type":"integer","format":"int32"},"maximumLength":{"type":"integer","format":"int32"}}},"BatchReplyItem":{"type":"object","properties":{"code":{"type":"number","format":"double"},"error":{"type":"string"},"body":{"$ref":"#/definitions/BatchItemBody"}}},"SessionRequest":{"type":"object","properties":{"minutesToLive":{"type":"integer","format":"int64"}}},"AccountOverview":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"isSuperUser":{"type":"boolean","default":false},"hasAccountNumber":{"type":"boolean","default":false},"usageCharges":{"type":"array","items":{"$ref":"#/definitions/Charge"}},"domesticChargesTotal":{"type":"integer","format":"int32"},"internationalChargesTotal":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FacetInfo":{"type":"object","properties":{"name":{"type":"string"},"entries":{"type":"array","items":{"$ref":"#/definitions/Entry"}}}},"DomainOrganizationProduct":{"type":"object","properties":{"id":{"type":"string"}}},"DependencyType":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"versioned":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AcwSettings":{"type":"object","properties":{"wrapupPrompt":{"type":"string","enum":["MANDATORY","OPTIONAL","MANDATORY_TIMEOUT","MANDATORY_FORCED_TIMEOUT"]},"timeoutMs":{"type":"integer","format":"int32"}}},"RuleSet":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"integer","format":"int32"},"contactList":{"$ref":"#/definitions/UriReference"},"queue":{"$ref":"#/definitions/UriReference"},"rules":{"type":"array","items":{"$ref":"#/definitions/Rule"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CarrierAddress":{"type":"object","properties":{"streetAddress1":{"type":"string"},"streetAddress2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zipcode":{"type":"string"}}},"DomainResourceConditionValue":{"type":"object","properties":{"user":{"$ref":"#/definitions/User"},"queue":{"$ref":"#/definitions/Queue"},"value":{"type":"string"},"type":{"type":"string","enum":["SCALAR","VARIABLE","USER","QUEUE"]}}},"Line":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"edgeGroup":{"$ref":"#/definitions/UriReference"},"template":{"$ref":"#/definitions/UriReference"},"site":{"$ref":"#/definitions/UriReference"},"lineBaseSettings":{"$ref":"#/definitions/UriReference"},"primaryEdge":{"$ref":"#/definitions/Edge"},"secondaryEdge":{"$ref":"#/definitions/Edge"},"loggedInUser":{"$ref":"#/definitions/UriReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PermissionCollectionEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionCollection"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TimeZone":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"standardOffset":{"type":"integer","format":"int64"},"offset":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeLogsJobRequest":{"type":"object","properties":{"path":{"type":"string"},"query":{"type":"string"},"recurse":{"type":"boolean","default":false}}},"PutManagementUnit":{"type":"object","properties":{"name":{"type":"string"},"startDayOfWeek":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"timezone":{"type":"string"}}},"Note":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"noteText":{"type":"string"},"modifyDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"createDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"QueueMember":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"ringNumber":{"type":"integer","format":"int32"},"joined":{"type":"boolean","default":false},"memberBy":{"type":"string"},"routingStatus":{"$ref":"#/definitions/RoutingStatus"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VoiceRateUpdate":{"type":"object","required":["amendmentDate","currency","effectiveDate"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"currency":{"type":"string","description":"The ISO 4217 currency code of the voice rate."},"inboundTollFree":{"description":"The inbound toll free rate.","$ref":"#/definitions/VoiceRate"},"extended":{"type":"array","description":"The domestic extended rates.","items":{"$ref":"#/definitions/VoiceRateExtended"}},"inboundTolled":{"description":"The inbound tolled rate.","$ref":"#/definitions/VoiceRate"},"outboundLocal":{"description":"The outbound local rate.","$ref":"#/definitions/VoiceRate"},"outboundIntraState":{"description":"The outbound intra-state rate.","$ref":"#/definitions/VoiceRate"},"outboundInterState":{"description":"The outbound inter-state rate.","$ref":"#/definitions/VoiceRate"},"outboundInternational":{"type":"array","description":"The outbound international rates.","items":{"$ref":"#/definitions/VoiceRateInternational"}},"amendmentDate":{"type":"string","format":"date-time","description":"The date of the rate amendment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"effectiveDate":{"type":"string","format":"date-time","description":"The effective date of the rate amendment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PolicyActions":{"type":"object","properties":{"retainRecording":{"type":"boolean","default":false},"deleteRecording":{"type":"boolean","default":false},"assignEvaluations":{"type":"array","items":{"$ref":"#/definitions/EvaluationAssignment"}},"assignMeteredEvaluations":{"type":"array","items":{"$ref":"#/definitions/MeteredEvaluationAssignment"}},"assignCalibrations":{"type":"array","items":{"$ref":"#/definitions/CalibrationAssignment"}},"retentionDuration":{"$ref":"#/definitions/RetentionDuration"}}},"TimeZoneEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/TimeZone"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AccountManager":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"}}},"SystemPromptAssetEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/SystemPromptAsset"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EvaluatorActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"evaluator":{"$ref":"#/definitions/User"},"numEvaluationsAssigned":{"type":"integer","format":"int32"},"numEvaluationsStarted":{"type":"integer","format":"int32"},"numEvaluationsCompleted":{"type":"integer","format":"int32"},"numCalibrationsAssigned":{"type":"integer","format":"int32"},"numCalibrationsStarted":{"type":"integer","format":"int32"},"numCalibrationsCompleted":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FaxSendRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"addresses":{"type":"array","items":{"type":"string"}},"originalFilename":{"type":"string"},"contentType":{"type":"string"},"workspace":{"$ref":"#/definitions/Workspace"},"coverSheet":{"$ref":"#/definitions/CoverSheet"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmbeddedSignatureView":{"type":"object","properties":{"view":{"$ref":"#/definitions/View"}}},"DomainEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Greeting":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","enum":["STATION","VOICEMAIL","NAME"]},"ownerType":{"type":"string","enum":["USER","ORGANIZATION"]},"owner":{"$ref":"#/definitions/DomainEntity"},"audioFile":{"$ref":"#/definitions/GreetingAudioFile"},"audioTTS":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"createdBy":{"type":"string","format":"uri"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WrapUpCodeMapping":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"integer","format":"int32"},"defaultSet":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["CONTACT_UNCALLABLE","NUMBER_UNCALLABLE","RIGHT_PARTY_CONTACT"]}},"mapping":{"type":"object","additionalProperties":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["CONTACT_UNCALLABLE","NUMBER_UNCALLABLE","RIGHT_PARTY_CONTACT"]}}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AuditMessage":{"type":"object","properties":{"id":{"type":"string"},"user":{"$ref":"#/definitions/User"},"correlationId":{"type":"string"},"transactionId":{"type":"string"},"transactionInitiator":{"type":"boolean","default":false},"application":{"type":"string"},"serviceName":{"type":"string"},"level":{"type":"string"},"timestamp":{"type":"string"},"receivedTimestamp":{"type":"string"},"status":{"type":"string"},"actionContext":{"type":"string"},"action":{"type":"string"},"changes":{"type":"array","items":{"$ref":"#/definitions/Change"}},"entity":{"$ref":"#/definitions/Entity"},"serviceContext":{"$ref":"#/definitions/ServiceContext"}}},"ServerDate":{"type":"object","properties":{"currentDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"SkillsToRemove":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"ScheduleGroup":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"timeZone":{"type":"string"},"openSchedules":{"type":"array","items":{"$ref":"#/definitions/UriReference"}},"closedSchedules":{"type":"array","items":{"$ref":"#/definitions/UriReference"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeLineEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/EdgeLine"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ProvisionInfo":{"type":"object","properties":{"time":{"type":"string","format":"date-time","description":"The time at which this phone was provisioned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"source":{"type":"string","description":"The source of the provisioning"},"errorInfo":{"type":"string","description":"The error information from the provision process, if any"}}},"Entry":{"type":"object","properties":{"value":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"ClientSpreadsheetTransform":{"type":"object","properties":{"id":{"type":"string"},"endpointId":{"type":"string"},"filenameReplaces":{"type":"array","items":{"$ref":"#/definitions/BasicTransform"}},"tags":{"type":"array","items":{"$ref":"#/definitions/TagModel"}},"name":{"type":"string"},"sheetNameReplaces":{"type":"array","items":{"$ref":"#/definitions/IndexedTransform"}},"sheets":{"type":"array","items":{"$ref":"#/definitions/SheetTransform"}}}},"WorkItemTransferRequest":{"type":"object","required":["transferTarget","transferTargetType"],"properties":{"transferTargetType":{"type":"string","description":"The type of the transferTarget, indicating whether you want to transfer to a User, or a Queue, etc.","enum":["USER","QUEUE"]},"transferTarget":{"type":"string","description":"The destination to where the work item should be transferred."}},"description":"Used as the body to the transferWorkItem request."},"ResourcePermissionPolicy":{"type":"object","properties":{"orgId":{"type":"string"},"id":{"type":"string"},"domain":{"type":"string"},"entityName":{"type":"string"},"policyName":{"type":"string"},"policyDescription":{"type":"string"},"actionSetKey":{"type":"string"},"resourceConditionNode":{"$ref":"#/definitions/ResourceConditionNode"},"namedResources":{"type":"array","items":{"type":"string"}},"resourceCondition":{"type":"string"},"actionSet":{"type":"array","uniqueItems":true,"items":{"type":"string"}}}},"FacetTerm":{"type":"object","properties":{"term":{"type":"string"},"key":{"type":"integer","format":"int64"},"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer","format":"int64"},"time":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"BatchItem":{"type":"object","properties":{"method":{"type":"string"},"url":{"type":"string"},"body":{"$ref":"#/definitions/BatchItemBody"}}},"ExpressionResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation date for the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date the entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"socialHub":{"type":"string","description":"The name of the social hub."},"conversation":{"description":"The conversation that this response is a part of.","$ref":"#/definitions/Conversation"},"twitterExpression":{"description":"The twitter expression that this is in response to.","$ref":"#/definitions/TwitterExpression"},"rawResponseText":{"type":"string","description":"The raw text of the response."},"socialAccount":{"description":"The Social Account used to publish this expression","$ref":"#/definitions/SocialAccount"},"socialHubResponseId":{"type":"string","description":"The id given to this response from the social hub"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ReplaceResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"changeNumber":{"type":"integer","format":"int32"},"uploadStatus":{"$ref":"#/definitions/UriReference"},"uploadDestinationUri":{"type":"string","format":"uri"},"uploadMethod":{"type":"string","enum":["SINGLE_PUT","MULTIPART_POST"]}}},"Queue":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/UriReference"}},"mediaSettings":{"type":"object","additionalProperties":{"$ref":"#/definitions/MediaSetting"}},"bullseye":{"$ref":"#/definitions/Bullseye"},"acwSettings":{"$ref":"#/definitions/AcwSettings"},"phoneNumber":{"type":"string"},"skillEvaluationMethod":{"type":"string","enum":["NONE","BEST","ALL"]},"queueFlow":{"$ref":"#/definitions/UriReference"},"callingPartyName":{"type":"string"},"callingPartyNumber":{"type":"string"},"memberCount":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QualityAudit":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"timestamp":{"type":"string"},"level":{"type":"string"},"entity":{"$ref":"#/definitions/Entity"},"action":{"type":"string"},"status":{"type":"string"},"changes":{"type":"array","items":{"$ref":"#/definitions/Change"}},"entityType":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DID":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"phoneNumber":{"type":"string"},"didPool":{"$ref":"#/definitions/UriReference"},"owner":{"description":"A Uri reference to the owner of this DID, which is either a User or an IVR","$ref":"#/definitions/UriReference"},"ownerType":{"type":"string","enum":["USER","PHONE","IVR_CONFIG","GROUP"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkspaceMember":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"workspace":{"$ref":"#/definitions/UriReference"},"memberType":{"type":"string","enum":["USER","GROUP"]},"member":{"$ref":"#/definitions/UriReference"},"user":{"$ref":"#/definitions/User"},"group":{"$ref":"#/definitions/Group"},"securityProfile":{"$ref":"#/definitions/SecurityProfile"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ManagementUnit":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"startDayOfWeek":{"type":"string"},"timezone":{"type":"string"},"version":{"type":"integer","format":"int32"}}},"EncryptionKeyEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/EncryptionKey"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainOrgRoleDifference":{"type":"object","properties":{"removedPermissionPolicies":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"addedPermissionPolicies":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"samePermissionPolicies":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"userOrgRole":{"$ref":"#/definitions/DomainOrganizationRole"},"roleFromDefault":{"$ref":"#/definitions/DomainOrganizationRole"}}},"NoteListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Note"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LibraryEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Library"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeLine":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"schema":{"$ref":"#/definitions/UriReference"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"edge":{"$ref":"#/definitions/Edge"},"edgeGroup":{"$ref":"#/definitions/EdgeGroup"},"lineType":{"type":"string","enum":["TIE","NETWORK","TRUNK","STATION"]},"endpoint":{"$ref":"#/definitions/Endpoint"},"ipAddress":{"type":"string"},"logicalInterfaceId":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RuleEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Rule"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CertificateAuthorityEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DomainCertificateAuthority"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainNetworkRoute":{"type":"object","properties":{"prefix":{"type":"string"},"nexthop":{"type":"string"},"persistent":{"type":"boolean","default":false},"metric":{"type":"integer","format":"int32"},"family":{"type":"integer","format":"int32"}}},"TrunkMetabaseEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Metabase"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SharedResponse":{"type":"object","properties":{"id":{"type":"string"},"downloadUri":{"type":"string","format":"uri"},"viewUri":{"type":"string","format":"uri"},"document":{"$ref":"#/definitions/Document"},"share":{"$ref":"#/definitions/Share"}}},"Relationship":{"type":"object","required":["externalOrganization","relationship","user"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"description":"The user associated with the external organization","$ref":"#/definitions/User"},"externalOrganization":{"description":"The external organization this relationship is attached to","$ref":"#/definitions/ExternalOrganization"},"relationship":{"type":"string","description":"The relationship or role of the user to this external organization.Examples: Account Manager, Sales Engineer, Implementation Consultant"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ReportRunEntry":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"reportId":{"type":"string"},"runTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"runStatus":{"type":"string","enum":["RUNNING","COMPLETED","COMPLETED_WITH_ERRORS"]},"errorMessage":{"type":"string"},"runDurationMsec":{"type":"integer","format":"int64"},"reportUrl":{"type":"string"},"reportFormat":{"type":"string"},"scheduleUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Parameter":{"type":"object","properties":{"name":{"type":"string"},"parameterType":{"type":"string","enum":["UUID","STRING","UUIDLIST","STRINGLIST"]},"domain":{"type":"string","enum":["USERID","QUEUEID","MEDIATYPE","DIALERCAMPAIGNID","QMEVALFORMID","UNKNOWN"]},"required":{"type":"boolean","default":false}}},"DialerDispositionCallCommand":{"type":"object","properties":{"callId":{"type":"string"},"wrapupCodeId":{"type":"string"},"contact":{"$ref":"#/definitions/Contact"}}},"SubDataItem":{"type":"object","required":["displayValue","id","prompt","type","value"],"properties":{"id":{"type":"string","description":"The id of this element"},"type":{"type":"string","description":"The 'type' of the element, this may be a system value, EG 'STRING' or a user defined type"},"value":{"type":"string","description":"The value of the element itself - This may be a simple value or more complex serialized data."},"prompt":{"type":"string","description":"The prompt displayed to the user that this data item was set from."},"displayValue":{"type":"string","description":"The display value that was offered to the user (as opposed to the actual value used internally"}},"description":"An additional data element that was set by the user for this event."},"ConversationQueryResponse":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Conversation"}},"hasMorePrev":{"type":"boolean","default":false},"hasMoreNext":{"type":"boolean","default":false},"startQueryTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"endQueryTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"newestResultTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"oldestResultTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"timeMs":{"type":"integer","format":"int64"},"iterations":{"type":"integer","format":"int32"},"anchor":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"sort":{"type":"string","enum":["ASC","DESC"]},"facets":{"$ref":"#/definitions/Facets"},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainEdgeSoftwareUpdateDto":{"type":"object","properties":{"version":{"$ref":"#/definitions/DomainEdgeSoftwareVersionDto"},"maxDownloadRate":{"type":"integer","format":"int32"},"downloadStartTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"executeStartTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"executeStopTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"executeOnIdle":{"type":"boolean","default":false},"status":{"type":"string","enum":["NONE","INIT","IN_PROGRESS","EXPIRED","EXCEPTION","ABORTED","FAILED","SUCCEEDED","DELETE"]},"edgeUri":{"type":"string","format":"uri"},"current":{"type":"boolean","default":false}}},"SignatureDocumentInfo":{"type":"object","properties":{"org":{"$ref":"#/definitions/Organization"},"user":{"$ref":"#/definitions/User"},"returnUrl":{"type":"string"}}},"CampaignSequence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"integer","format":"int32"},"campaigns":{"type":"array","items":{"$ref":"#/definitions/UriReference"}},"currentCampaign":{"type":"integer","format":"int32"},"status":{"type":"string","enum":["ON","OFF","COMPLETE"]},"stopMessage":{"type":"string"},"repeat":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CalibrationAssignment":{"type":"object","properties":{"calibrator":{"$ref":"#/definitions/User"},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"expertEvaluator":{"$ref":"#/definitions/User"}}},"EdgeVersionReport":{"type":"object","properties":{"oldestVersion":{"$ref":"#/definitions/EdgeVersionInformation"},"newestVersion":{"$ref":"#/definitions/EdgeVersionInformation"}}},"WrapupCodeEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ExpansionCriterium":{"type":"object","properties":{"type":{"type":"string","enum":["TIMEOUT_SECONDS"]},"threshold":{"type":"number","format":"double"}}},"QuoteCharge":{"type":"object","required":["chargeType","discount","effectivePrice","id","listPriceDisplay","listTotal","name","productShippable","quantity","shippingAddress","sku","total"],"properties":{"id":{"type":"string","description":"The quote charge Id."},"sku":{"type":"string","description":"The quote charge SKU."},"name":{"type":"string","description":"The quote charge name."},"chargeType":{"type":"string","description":"The quote charge type."},"quantity":{"type":"integer","format":"int32","description":"The quote charge quantity."},"listTotal":{"type":"string","description":"The quote charge total price before discounts."},"total":{"type":"string","description":"The quote charge total price after discounts."},"listPriceDisplay":{"type":"string","description":"The quote charge list price before discounts."},"discount":{"type":"string","description":"The quote charge discount percent."},"effectivePrice":{"type":"string","description":"The quote charge list price after discounts."},"productShippable":{"type":"boolean","description":"Indicates whether the product can be shipped.","default":false},"shippingAddress":{"description":"The quote shipping address.","$ref":"#/definitions/Address"},"forRelatedPart":{"type":"string","description":"The part number of a part related to the quote charge."}}},"CampaignSchedule":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"integer","format":"int32"},"intervals":{"type":"array","items":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"end":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}}},"timeZone":{"type":"string"},"campaign":{"$ref":"#/definitions/UriReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Email":{"type":"object","properties":{"state":{"type":"string","enum":["ALERTING","CONNECTED","DISCONNECTED","NONE"]},"id":{"type":"string"},"held":{"type":"boolean","default":false},"subject":{"type":"string"},"messagesSent":{"type":"integer","format":"int32"},"segments":{"type":"array","items":{"$ref":"#/definitions/Segment"}},"direction":{"type":"string","enum":["INBOUND","OUTBOUND"]},"recordingId":{"type":"string"},"errorInfo":{"$ref":"#/definitions/ErrorBody"},"disconnectType":{"type":"string","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"startHoldTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"connectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"SystemPromptAsset":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"promptId":{"type":"string"},"language":{"type":"string"},"durationSeconds":{"type":"number","format":"double"},"mediaUri":{"type":"string"},"ttsString":{"type":"string"},"uploadUri":{"type":"string"},"uploadStatus":{"type":"string","enum":["CREATED","UPLOADED","TRANSCODED"]},"hasDefault":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DIDPool":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"startPhoneNumber":{"type":"string","description":"The starting phone number for the range of this DID pool. Must be in E.164 format"},"endPhoneNumber":{"type":"string","description":"The ending phone number for the range of this DID pool. Must be in E.164 format"},"comments":{"type":"string"},"provider":{"type":"string","description":"The provider for this DID pool","enum":["PURE_CLOUD","PURE_CLOUD_VOICE"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DiagnosticEmail":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"subject":{"type":"string"},"topic":{"type":"string"},"description":{"type":"string"},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"type":{"type":"string","enum":["PROBLEM","FEATURE_REQUEST","QUESTION","TECHNICAL_ISSUE","NON_TECHNICAL_ISSUE"]},"data":{"type":"object"}}},"Attachment":{"type":"object","properties":{"attachmentId":{"type":"string"},"name":{"type":"string"},"contentUri":{"type":"string"},"contentType":{"type":"string"},"contentLength":{"type":"integer","format":"int32"}}},"SortField":{"type":"object","properties":{"name":{"type":"string"},"sortType":{"type":"string","enum":["ASCENDING","DESCENDING"]}}},"OAuthProvider":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TemplateEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Template"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportMetaData":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"keywords":{"type":"array","items":{"type":"string"}},"availableLocales":{"type":"array","items":{"type":"string"}},"parameters":{"type":"array","items":{"$ref":"#/definitions/Parameter"}},"exampleUrl":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrunkBaseAssignment":{"type":"object","properties":{"family":{"type":"integer","format":"int32","description":"The address family to use with the trunk base settings. 2=IPv4, 23=IPv6"},"trunkBase":{"description":"A trunk base settings reference.","$ref":"#/definitions/UriReference"}}},"ExternalOrganizationListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalOrganization"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RuleSetEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/RuleSet"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainSchemaReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowConfigId":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"version":{"type":"string","description":"Version of this flow config."}},"description":"ID of a Flow Definition with an optional version"},"UserSkillEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/UserSkill"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WorkspaceMemberEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/WorkspaceMember"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainVoiceRateResponseItemEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/VoiceRate"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ErrorBody":{"type":"object","properties":{"status":{"type":"integer","format":"int32"},"code":{"type":"string"},"entityId":{"type":"string"},"entityName":{"type":"string"},"message":{"type":"string"},"messageWithParams":{"type":"string"},"messageParams":{"type":"object","additionalProperties":{"type":"string"}},"contextId":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/definitions/Detail"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ErrorBody"}}}},"FaxSendResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"uploadDestinationUri":{"type":"string","format":"uri"},"uploadMethodType":{"type":"string","enum":["SINGLE_PUT","MULTIPART_POST"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrganizationCreate":{"type":"object","required":["adminPassword","adminUsername","domain","name","thirdPartyOrgName"],"properties":{"name":{"type":"string","description":"Display Name for Organization"},"adminUsername":{"type":"string","description":"Administrator username for this organization"},"adminPassword":{"type":"string","description":"Administrator password for this organization"},"domain":{"type":"string","description":"Fully qualified domain name for this organization (Ex. example.com)."},"thirdPartyOrgName":{"type":"string","description":"Organization Name which does not contain special characters like spaces."},"deletable":{"type":"boolean","description":"Deletable Property for Organization.","default":false}},"description":"Creating an Organization"},"ChatMessage":{"type":"object","properties":{"body":{"type":"string"},"id":{"type":"string"},"to":{"type":"string"},"from":{"type":"string"},"utc":{"type":"string"},"chat":{"type":"string"},"message":{"type":"string"},"type":{"type":"string"},"user":{"$ref":"#/definitions/ChatMessageUser"}}},"WorkItemCache":{"type":"object","properties":{"workItemExecId":{"type":"string","description":"The workItem instance ID that owns this cache."},"saveTime":{"type":"string","format":"date-time","description":"The time that the workItem cache was last saved. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"saveUser":{"description":"The user that last saved the workItem cache.","$ref":"#/definitions/User"},"saveComment":{"type":"string","description":"An optional comment made during the last save"},"dataItems":{"type":"array","description":"The data items that are present within the cache.","items":{"$ref":"#/definitions/DataItem"}}}},"CustomerAccount":{"type":"object","required":["billingAddress","currency","isFrozen","isTaxExempt","orgLegalName","orgPhone"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"isFrozen":{"type":"boolean","description":"Indicates whether the account is currently frozen for review.","default":false},"orgLegalName":{"type":"string","description":"The organization legal name."},"orgPhone":{"type":"string","description":"The organization phone number."},"isTaxExempt":{"type":"boolean","description":"Indicates whether the account is tax exempt.","default":false},"billingAddress":{"description":"The account billing address.","$ref":"#/definitions/Address"},"currency":{"type":"string","description":"The account currency."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SocializeFilterRequest":{"type":"object","properties":{"filters":{"type":"array","description":"The list of filters used to narrow the return.","items":{"$ref":"#/definitions/SocializeEntityFilter"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"sortBy":{"type":"string"},"sortOrder":{"type":"string","enum":["ascending","descending"]}}},"FlowUploadResponse":{"type":"object","properties":{"uri":{"type":"string","format":"uri","description":"uri destination to upload file to"},"uploadToken":{"type":"string","description":"token to send along when creating versioned flow so the file can be bound to the metadata"}},"description":"Data containing details to upload a flow definition to for post versioned flows."},"TransformModel":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"restEndpoint":{"$ref":"#/definitions/TransformEndpoint"},"filenameTransforms":{"type":"array","items":{"$ref":"#/definitions/BasicTransform"}},"tags":{"type":"array","items":{"$ref":"#/definitions/TagModel"}},"clientTransformModel":{"$ref":"#/definitions/ClientTransformModel"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MeteredEvaluationAssignment":{"type":"object","properties":{"evaluationContextId":{"type":"string"},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"maxNumberEvaluations":{"type":"integer","format":"int32"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"assignToActiveUser":{"type":"boolean","default":false},"timeInterval":{"$ref":"#/definitions/TimeInterval"}}},"DeletedResourceConsumerEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DependencyObject"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Video":{"type":"object","properties":{"state":{"type":"string","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","NONE"]},"id":{"type":"string"},"context":{"type":"string"},"audioMuted":{"type":"boolean","default":false},"videoMuted":{"type":"boolean","default":false},"sharingScreen":{"type":"boolean","default":false},"peerCount":{"type":"integer","format":"int32"},"disconnectType":{"type":"string","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"connectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"MediaSetting":{"type":"object","properties":{"alertingTimeoutSeconds":{"type":"integer","format":"int32"},"serviceLevel":{"$ref":"#/definitions/ServiceLevel"}}},"DomainLicense":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"product":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AgentActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"agent":{"$ref":"#/definitions/User"},"numEvaluations":{"type":"integer","format":"int32"},"averageEvaluationScore":{"type":"integer","format":"int32"},"agentEvaluatorActivityList":{"type":"array","items":{"$ref":"#/definitions/AgentEvaluatorActivity"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DependencyTypeEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DependencyType"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ConsultTransfer":{"type":"object","required":["destination"],"properties":{"speakTo":{"type":"string","description":"Determines to whom the initiating participant is speaking. Defaults to DESTINATION","enum":["DESTINATION","OBJECT","BOTH"]},"destination":{"description":"Destination phone number and name.","$ref":"#/definitions/Destination"}}},"SearchRequest":{"type":"object","properties":{"searchPhrase":{"type":"string","description":"The search text to look for"},"pageNumber":{"type":"integer","format":"int32","description":"The pageNumber to get results from (EG If there are 100 results with a pageSize of 10 and pageNumber is 3 then 10 results will be returned starting with index #31"},"pageSize":{"type":"integer","format":"int32","description":"Number of entries to return/calculate per page."},"searchFields":{"type":"array","description":"The fields to limit the searchPhrase search to","items":{"type":"string"}},"facetRequests":{"type":"array","description":"List of facet requests to generate summary views from the search result set (if any)","items":{"$ref":"#/definitions/FacetRequest"}},"sort":{"type":"array","description":"sort the results on a field(s)","items":{"$ref":"#/definitions/SortField"}},"filters":{"type":"array","description":"You can also restrict the search to particular field values and ranges","items":{"$ref":"#/definitions/FilterItem"}}},"description":"Used to perform a search on various data stored in search engines"},"QueuesEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/AutomateQueue"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WorkspaceEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Workspace"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"VoicemailOrganizationPolicy":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"retentionTimeDays":{"type":"integer","format":"int32"},"alertTimeoutSeconds":{"type":"integer","format":"int32"},"minimumRecordingTimeSeconds":{"type":"integer","format":"int32"},"maximumRecordingTimeSeconds":{"type":"integer","format":"int32"},"unavailableMessageUri":{"type":"string","format":"uri"},"namePromptMessageUri":{"type":"string","format":"uri"},"fullMessageUri":{"type":"string","format":"uri"},"compressSilence":{"type":"boolean","default":false},"pinConfiguration":{"$ref":"#/definitions/PINConfiguration"},"quotaSizeBytes":{"type":"integer","format":"int64"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"voicemailExtension":{"type":"string","description":"The extension for voicemail retrieval.  The default value is *86."},"pinRequired":{"type":"boolean","description":"If this is true, a PIN is required when accessing a user's voicemail from a phone.","default":false}}},"IVR":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"ivrUri":{"type":"string"},"dnis":{"type":"array","items":{"type":"string"}},"flowId":{"type":"string"},"scheduleId":{"type":"string"},"openHoursFlow":{"$ref":"#/definitions/UriReference"},"closedHoursFlow":{"$ref":"#/definitions/UriReference"},"scheduleGroup":{"$ref":"#/definitions/UriReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Form":{"type":"object","properties":{"controls":{"type":"array","items":{"$ref":"#/definitions/Control"}}}},"CoverSheet":{"type":"object","properties":{"notes":{"type":"string","description":"Text to be added to the coversheet"},"locale":{"type":"string","description":"Locale, e.g. = en-US"}}},"EvaluationScoringSet":{"type":"object","properties":{"totalScore":{"type":"number","format":"float"},"totalCriticalScore":{"type":"number","format":"float"},"questionGroupScores":{"type":"array","items":{"$ref":"#/definitions/QuestionGroupScore"}},"anyFailedKillQuestions":{"type":"boolean","default":false},"comments":{"type":"string"},"agentComments":{"type":"string"}}},"CampaignSequenceEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/CampaignSequence"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Gistener":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation date for the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date the entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"enabled":{"type":"boolean","description":"Indicates if this Gistener may be utilized on another entity","default":false},"anyWords":{"type":"string","description":"A tweet must contain any one of these words"},"allWords":{"type":"string","description":"A tweet must contain every one of these words in any order"},"excludeWords":{"type":"string","description":"If a tweet contains any one of these words, it is thrown out"},"exactPhrase":{"type":"string","description":"A tweet must contain this exact quoted phrase"},"groupTags":{"type":"array","description":"The group tags associated with this Gistener","items":{"$ref":"#/definitions/GroupTag"}},"socialAccount":{"description":"The social account associated with this Gistener","$ref":"#/definitions/SocialAccount"},"queue":{"description":"The operator queue the gistener will route to.","$ref":"#/definitions/Queue"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AttributeEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Attribute"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Number":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}}},"Language":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"state":{"type":"string","enum":["ACTIVE","INACTIVE","DELETED"]},"version":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConversationHistoricalQueryRequestBody":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32","description":"Maximum number of conversations returned. Overrides 'maximum' if both specified. Default 100"},"maximum":{"type":"integer","format":"int32","description":"Maximum number of conversations returned"},"filters":{"type":"array","description":"Query filters. Default is all conversations for the previous 7 days","items":{"$ref":"#/definitions/ConversationHistoricalQueryRequestFilter"}},"facets":{"type":"array","description":"Facets to return. Currently, only 'queue' is supported","items":{"type":"string"}}},"description":"Historical conversation request parameters"},"Vpn":{"type":"object","properties":{"type":{"type":"string"},"ip":{"type":"string"},"psk":{"type":"string"}}},"FlowBody":{"type":"object","properties":{"format":{"type":"string","description":"The 'format' indicates the particular format of the 'body' contents.  Reference the Automate documentation for format information."},"body":{"type":"object","description":"The flow definition body according to the syntax supported by the 'format'.  Use the /processautomation/flows/schemas endpoint to get detailed syntax information for each format.","additionalProperties":{"type":"object"}}}},"BackendFlowAvailableActions":{"type":"object","properties":{"canTerminate":{"type":"boolean","default":false}}},"EmailSetup":{"type":"object","properties":{"rootDomain":{"type":"string","description":"The root PureCloud domain that all sub-domains are created from."}}},"Salesforce":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"certificate":{"type":"string"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DeltaResponse":{"type":"object","properties":{"contextToken":{"type":"string"},"documents":{"type":"array","items":{"$ref":"#/definitions/DeltaDocument"}},"hasMore":{"type":"boolean","default":false}}},"Condition":{"type":"object","properties":{"type":{"type":"string"},"inverted":{"type":"boolean","default":false},"attributeName":{"type":"string"},"value":{"type":"string"},"valueType":{"type":"string","enum":["STRING","NUMERIC","DATETIME","PERIOD"]},"operator":{"type":"string","enum":["EQUALS","LESS_THAN","LESS_THAN_EQUALS","GREATER_THAN","GREATER_THAN_EQUALS","CONTAINS","BEGINS_WITH","ENDS_WITH","BEFORE","AFTER"]},"codes":{"type":"array","items":{"type":"string"}}}},"OAuthProviderEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OAuthProvider"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PromptAsset":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"promptId":{"type":"string"},"language":{"type":"string"},"mediaUri":{"type":"string"},"ttsString":{"type":"string"},"uploadStatus":{"type":"string"},"uploadUri":{"type":"string"},"durationSeconds":{"type":"number","format":"double"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FacetResultItem":{"type":"object","properties":{"name":{"type":"string","description":"For TERM facets this will contain the value of the term that was found userid, docid, etc."},"count":{"type":"integer","format":"int64","description":"The number of items that matched the facetRequest."},"document":{"$ref":"#/definitions/Document"},"user":{"$ref":"#/definitions/User"},"queue":{"$ref":"#/definitions/Queue"},"flowConfigId":{"$ref":"#/definitions/FlowConfigId"},"workspace":{"$ref":"#/definitions/Workspace"}}},"EmailAttachment":{"type":"object","properties":{"name":{"type":"string"},"contentPath":{"type":"string"},"contentType":{"type":"string"},"attachmentId":{"type":"string"},"contentLength":{"type":"integer","format":"int32"}}},"FlowHistoryResultItemEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/FlowHistoryResultItem"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RecordingSettings":{"type":"object","properties":{"maxSimultaneousStreams":{"type":"integer","format":"int32"}}},"AutomateQueueMemberEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/AutomateQueueMember"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainPhysicalCapabilities":{"type":"object","properties":{"vlan":{"type":"boolean","default":false},"team":{"type":"boolean","default":false}}},"ContentQueryRequest":{"type":"object","properties":{"queryPhrase":{"type":"string"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"facetNameRequests":{"type":"array","items":{"type":"string"}},"sort":{"type":"array","items":{"$ref":"#/definitions/ContentSortItem"}},"filters":{"type":"array","items":{"$ref":"#/definitions/ContentFacetFilterItem"}},"attributeFilters":{"type":"array","items":{"$ref":"#/definitions/ContentAttributeFilterItem"}}}},"ChatSearchRequest":{"type":"object","required":["order","query"],"properties":{"query":{"type":"string","description":"Search terms can be AND'd together. Example: foo AND bar"},"order":{"type":"string","description":"Sort order of results by score or most recent. Default is by score","enum":["SCORE","RECENT"]},"targetJids":{"type":"array","description":"A list of XMPP JIDs to consider. Default is all permissible JIDs. A permissible JID is defined as any JID of a person with whom you have chatted, or any group in which you are currently a member.","items":{"type":"string"}},"pageSize":{"type":"integer","format":"int32","description":"The maximum number of hits to receive in the response. Default: 10, Maximum: 50]"},"pageNumber":{"type":"integer","format":"int32","description":"The number of hits to skip before returning results. Default: 0"},"fromDate":{"type":"string","format":"date-time","description":"Consider hits after this date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"toDate":{"type":"string","format":"date-time","description":"Consider hits before this date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"expand":{"type":"string","description":"Expand the 'to' or 'from' user details.","enum":["to","from"]}}},"FilterItem":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST","GROUP"]},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","ORGROUP","ANDGROUP","NOTGROUP"]},"values":{"type":"array","items":{"type":"string"}},"filters":{"type":"array","items":{"$ref":"#/definitions/FilterItem"}}}},"ReportScheduleEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ReportSchedule"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainInvoiceEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Invoice"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"QuoteListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Quote"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OrgMediaUtilization":{"type":"object","properties":{"maximumCapacity":{"type":"integer","format":"int32","description":"Defines the maximum number of conversations of this type that an agent can handle at one time."},"interruptableMediaTypes":{"type":"array","description":"Defines the list of other media types that can interrupt a conversation of this media type.  Values can be: call, chat, email, or socialExpression","items":{"type":"string"}}}},"Schedule":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"start":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"end":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"rrule":{"type":"string","description":"An iCal Recurrence Rule (RRULE) string"},"keywords":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VoiceRatesCsv":{"type":"object","required":["name","url"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the rate csv."},"url":{"type":"string","description":"The url of the rate csv."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QuestionGroupScore":{"type":"object","properties":{"questionGroupId":{"type":"string"},"totalScore":{"type":"number","format":"float"},"maxTotalScore":{"type":"number","format":"float"},"totalCriticalScore":{"type":"number","format":"float"},"maxTotalCriticalScore":{"type":"number","format":"float"},"totalScoreUnweighted":{"type":"number","format":"float"},"maxTotalScoreUnweighted":{"type":"number","format":"float"},"totalCriticalScoreUnweighted":{"type":"number","format":"float"},"maxTotalCriticalScoreUnweighted":{"type":"number","format":"float"},"markedNA":{"type":"boolean","default":false},"questionScores":{"type":"array","items":{"$ref":"#/definitions/QuestionScore"}}}},"VoiceXmlOperationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/VoiceXmlOperation"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ThirdPartyAccount":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"accountNumber":{"type":"string"},"currency":{"type":"string"},"invoices":{"type":"array","items":{"$ref":"#/definitions/Invoice"}},"subscriptions":{"type":"array","items":{"$ref":"#/definitions/ThirdPartySubscription"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AssociatedDocument":{"type":"object","required":["document"],"properties":{"document":{"description":"the document associated with the workitem","$ref":"#/definitions/Document"},"documentAssociationType":{"type":"string","description":"the document association type","enum":["UNKNOWN","MAIN","SECONDARY"]}},"description":"Contains information about the Document associated with a workItem"},"IntegrationTypeEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/IntegrationType"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Address":{"type":"object","properties":{"country":{"type":"string"},"A1":{"type":"string"},"A3":{"type":"string"},"RD":{"type":"string"},"HNO":{"type":"string"},"LOC":{"type":"string"},"NAM":{"type":"string"},"PC":{"type":"string"}}},"FacetFilterItem":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST"]},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","CONTAINS"]},"values":{"type":"array","items":{"type":"string"}}}},"UserQueueEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/UserQueue"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ParticipantAttributes":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"type":"string"}}}},"AuditSearchResult":{"type":"object","properties":{"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"pageCount":{"type":"integer","format":"int32"},"facetInfo":{"type":"array","items":{"$ref":"#/definitions/FacetInfo"}},"auditMessages":{"type":"array","items":{"$ref":"#/definitions/AuditMessage"}}}},"Dns":{"type":"object","properties":{"id":{"type":"string"},"ip":{"type":"string"},"port":{"type":"integer","format":"int32"}}},"License":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"}}},"UserQueue":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/UriReference"}},"mediaSettings":{"type":"object","additionalProperties":{"$ref":"#/definitions/MediaSetting"}},"bullseye":{"$ref":"#/definitions/Bullseye"},"acwSettings":{"$ref":"#/definitions/AcwSettings"},"phoneNumber":{"type":"string"},"skillEvaluationMethod":{"type":"string","enum":["NONE","BEST","ALL"]},"queueFlow":{"$ref":"#/definitions/UriReference"},"callingPartyName":{"type":"string"},"callingPartyNumber":{"type":"string"},"joined":{"type":"boolean","default":false},"memberCount":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AuditChange":{"type":"object","properties":{"property":{"type":"string"},"entity":{"$ref":"#/definitions/AuditEntityReference"},"oldValues":{"type":"array","items":{"type":"string"}},"newValues":{"type":"array","items":{"type":"string"}}}},"ClientTextTableTransform":{"type":"object","properties":{"id":{"type":"string"},"endpointId":{"type":"string"},"filenameReplaces":{"type":"array","items":{"$ref":"#/definitions/BasicTransform"}},"tags":{"type":"array","items":{"$ref":"#/definitions/TagModel"}},"name":{"type":"string"},"comments":{"type":"string"},"delimiter":{"type":"string"},"table":{"$ref":"#/definitions/TableTransform"}}},"DomainVoiceRateExtendedResponseItemEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/VoiceRateExtended"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"HardwareRateListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/HardwareRate"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DialerPreview":{"type":"object","properties":{"id":{"type":"string"},"contactId":{"type":"string"},"contactListId":{"type":"string"},"campaignId":{"type":"string"},"phoneNumberColumns":{"type":"array","items":{"$ref":"#/definitions/PhoneNumberColumn"}}}},"UriReference":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"Agent":{"type":"object","properties":{"stage":{"type":"string"}}},"EdgeGroup":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"managed":{"type":"boolean","description":"Is this edge group being managed remotely.","default":false},"edgeTrunkBaseAssignment":{"description":"A trunk base settings assignment of trunkType \"EDGE\" to use for edge-to-edge communication.","$ref":"#/definitions/TrunkBaseAssignment"},"phoneTrunkBaseAssignments":{"type":"array","description":"Trunk base settings assignments of trunkType \"PHONE\" to inherit to edge logical interfaces for phone communication.","items":{"$ref":"#/definitions/TrunkBaseAssignment"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationAssignment":{"type":"object","properties":{"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"user":{"$ref":"#/definitions/User"}}},"OutboundRoute":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"site":{"$ref":"#/definitions/Site"},"classificationTypes":{"type":"array","items":{"type":"string"}},"enabled":{"type":"boolean","default":false},"distribution":{"type":"string","enum":["SEQUENTIAL","RANDOM"]},"managed":{"type":"boolean","default":false},"externalTrunkBases":{"type":"array","description":"Trunk base settings of trunkType \"EXTERNAL\".  This base must also be set on an edge logical interface for correct routing.","items":{"$ref":"#/definitions/UriReference"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BillingPeriod":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"startDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"endDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Actions":{"type":"object","properties":{"skillsToRemove":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/SkillsToRemove"}}}},"Rate":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"partNumber":{"type":"string"},"tiers":{"type":"array","items":{"$ref":"#/definitions/Tier"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Publication":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation date for the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date the entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"tweetText":{"type":"string","description":"The text of the tweet."},"rawTweetText":{"type":"string","description":"The raw text of the tweet"},"approved":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TextTableTransform":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"restEndpoint":{"$ref":"#/definitions/TransformEndpoint"},"filenameTransforms":{"type":"array","items":{"$ref":"#/definitions/BasicTransform"}},"tags":{"type":"array","items":{"$ref":"#/definitions/TagModel"}},"commentSymbol":{"type":"string"},"delimiter":{"type":"string"},"table":{"$ref":"#/definitions/TableTransform"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeGroupEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/EdgeGroup"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CampaignDiagnostics":{"type":"object","properties":{"callableContacts":{"$ref":"#/definitions/CallableContactsDiagnostic"},"queueUtilizationDiagnostic":{"$ref":"#/definitions/QueueUtilizationDiagnostic"},"outstandingInteractionsCount":{"type":"integer","format":"int32"}}},"TrunkBase":{"type":"object","required":["trunkMetabase","trunkType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"trunkMetabase":{"description":"The meta-base this trunk is based on.","$ref":"#/definitions/UriReference"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"trunkType":{"type":"string","description":"The type of this trunk base.","enum":["EXTERNAL","PHONE","EDGE"]},"managed":{"type":"boolean","description":"Is this trunk being managed remotely.","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmailAddress":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"}}},"ResourceConditionNode":{"type":"object","properties":{"variableName":{"type":"string"},"conjunction":{"type":"string","enum":["AND","OR"]},"operator":{"type":"string","enum":["EQ","IN","GE","GT","LE","LT"]},"operands":{"type":"array","items":{"$ref":"#/definitions/ResourceConditionValue"}},"terms":{"type":"array","items":{"$ref":"#/definitions/ResourceConditionNode"}}}},"ExtensionEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Extension"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LockInfo":{"type":"object","properties":{"lockedBy":{"$ref":"#/definitions/UriReference"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateExpires":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"action":{"type":"string","enum":["UPDATE","DELETE","COPY","MOVE","REPLACE","THUMBNAIL","TEXT_EXTRACTION"]}}},"OutOfOffice":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"startDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"endDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"active":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AvailableTopic":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true}}},"PromptAssetEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/PromptAsset"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UnreadMetric":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}}},"AttributeFilterItem":{"type":"object","properties":{"id":{"type":"string"},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","CONTAINS"]},"values":{"type":"array","items":{"type":"string"}}}},"Organization":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"thirdPartyOrgId":{"type":"string"},"thirdPartyOrgName":{"type":"string"},"thirdPartyURI":{"type":"string","format":"uri"},"adminUsername":{"type":"string"},"adminPassword":{"type":"string"},"domain":{"type":"string"},"version":{"type":"integer","format":"int32"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"defaultSiteId":{"type":"string"},"deletable":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Discount":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"annualPrePay":{"type":"boolean","default":false},"discount":{"type":"string"},"maximum":{"type":"string"},"minimum":{"type":"string"},"productCategory":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Facets":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"facetGroups":{"type":"array","items":{"$ref":"#/definitions/FacetGroup"}}}},"SpreadsheetTransformEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ClientSpreadsheetTransform"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SortBy":{"type":"object","properties":{"name":{"type":"string"},"ascending":{"type":"boolean","default":false}}},"Conversation":{"type":"object","required":["participants","startTime"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"startTime":{"type":"string","format":"date-time","description":"The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"endTime":{"type":"string","format":"date-time","description":"The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"address":{"type":"string","description":"The address of the conversation as seen from an external participant. For phone calls this will be the DNIS for inbound calls and the ANI for outbound calls. For other media types this will be the address of the destination participant for inbound and the address of the initiating participant for outbound."},"participants":{"type":"array","description":"The list of all participants in the conversation.","items":{"$ref":"#/definitions/Participant"}},"conversationIds":{"type":"array","description":"A list of conversations to merge into this conversation to create a conference. This field is null except when being used to create a conference.","items":{"type":"string"}},"maxParticipants":{"type":"integer","format":"int32","description":"If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference."},"recordingState":{"type":"string","description":"On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings; otherwise indicates state of conversation recording.","enum":["ACTIVE","PAUSED","NONE"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Document"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RoutingStatus":{"type":"object","properties":{"userId":{"type":"string"},"status":{"type":"string","enum":["OFF_QUEUE","IDLE","INTERACTING","NOT_RESPONDING"]},"startTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"Okta":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"certificate":{"type":"string"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TableTransform":{"type":"object","properties":{"headerRow":{"type":"integer","format":"int32"},"firstData":{"type":"integer","format":"int32"},"headerReplaces":{"type":"array","items":{"$ref":"#/definitions/IndexedTransform"}},"columns":{"type":"array","items":{"$ref":"#/definitions/IndexedTransform"}},"unpivots":{"type":"array","items":{"$ref":"#/definitions/UnpivotColumns"}},"collapses":{"type":"array","items":{"$ref":"#/definitions/ColumnCollapse"}}}},"FlowBodyFormat":{"type":"object","properties":{"schemaUri":{"type":"string","format":"uri"},"description":{"type":"string"}}},"ResponseEntityList":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Response"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}},"description":"Query result list"},"ControlOptions":{"type":"object","properties":{"value":{"type":"string"},"label":{"type":"string"}}},"LocationEmergencyNumber":{"type":"object","properties":{"e164":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","description":"The type of emergency number.","enum":["default","elin"]}}},"DocumentUpdate":{"type":"object","properties":{"changeNumber":{"type":"integer","format":"int32"},"name":{"type":"string"},"read":{"type":"boolean","default":false},"addTags":{"type":"array","items":{"type":"string"}},"removeTags":{"type":"array","items":{"type":"string"}},"addTagIds":{"type":"array","items":{"type":"string"}},"removeTagIds":{"type":"array","items":{"type":"string"}},"updateAttributes":{"type":"array","items":{"$ref":"#/definitions/DocumentAttribute"}},"removeAttributes":{"type":"array","items":{"type":"string"}}}},"VoicemailMediaInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"mediaFileUri":{"type":"string","format":"uri"},"mediaImageUri":{"type":"string","format":"uri"}}},"FlowVersionConfigMetaDataEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/FlowVersionConfigMetaData"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ScheduleEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Schedule"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContentSortItem":{"type":"object","properties":{"name":{"type":"string"},"ascending":{"type":"boolean","default":false}}},"NumberPlan":{"type":"object","required":["matchType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"match":{"type":"string"},"normalizedFormat":{"type":"string"},"priority":{"type":"integer","format":"int32"},"numbers":{"type":"array","items":{"$ref":"#/definitions/Number"}},"digitLength":{"$ref":"#/definitions/DigitLength"},"classification":{"type":"string"},"matchType":{"type":"string","description":"The type of matching technique the number plan uses.","enum":["e164NumberList","numberList","digitLength","regex","intraCountryCode","interCountryCode"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrganizationPresence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"languageLabels":{"type":"object","additionalProperties":{"type":"string"}},"systemPresence":{"type":"string","enum":["AVAILABLE","AWAY","BUSY","OUT_OF_OFFICE","OFFLINE","ON_QUEUE","IDLE"]},"deactivated":{"type":"boolean","default":false},"createdBy":{"$ref":"#/definitions/User"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"$ref":"#/definitions/User"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MediaPolicies":{"type":"object","properties":{"callPolicy":{"description":"Conditions and actions for calls","$ref":"#/definitions/MediaPolicy"},"chatPolicy":{"description":"Conditions and actions for chats","$ref":"#/definitions/MediaPolicy"},"emailPolicy":{"description":"Conditions and actions for emails","$ref":"#/definitions/MediaPolicy"}}},"BatchItemBody":{"type":"object","properties":{"name":{"type":"string"}}},"EvaluatorActivityEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/EvaluatorActivity"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"VoicemailUserPolicy":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"alertTimeoutSeconds":{"type":"integer","format":"int32"},"minimumRecordingTimeSeconds":{"type":"integer","format":"int32"},"maximumRecordingTimeSeconds":{"type":"integer","format":"int32"},"unavailableMessageUri":{"type":"string","format":"uri"},"namePromptMessageUri":{"type":"string","format":"uri"},"fullMessageUri":{"type":"string","format":"uri"},"pin":{"type":"string"},"quotaSizeBytes":{"type":"integer","format":"int64"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"ReportRequest":{"type":"object","properties":{"pageNumber":{"type":"integer","format":"int32","description":"The pageNumber to get results from (EG If there are 100 results with a pageSize of 10 and pageNumber is 3 then 10 results will be returned starting with index #31"},"pageSize":{"type":"integer","format":"int32","description":"Number of entries to return/calculate per page."},"facetRequests":{"type":"array","description":"List of facet requests to generate summary views from the report result set (if any)","items":{"$ref":"#/definitions/FacetRequest"}},"sort":{"type":"array","description":"sort the results on a field(s)","items":{"$ref":"#/definitions/SortField"}},"filters":{"type":"array","description":"You can also restrict the request to particular field values and ranges","items":{"$ref":"#/definitions/FilterItem"}},"groupBy":{"type":"array","items":{"type":"string","enum":["USER","FLOW","QUEUE"]}}},"description":"Used to perform a search on various data stored in search engines"},"TwitterExpression":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation date for the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date the entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"isDispositioned":{"type":"boolean","description":"True once the expression has been dispositioned by an agent through the ACD process","default":false},"isNoise":{"type":"boolean","description":"Indicates if a user/agent found this expression to be undesirable","default":false},"gistener":{"description":"The Gistener that generated this expression","$ref":"#/definitions/Gistener"},"tweetId":{"type":"string","description":"Twitter: the tweet's unique id"},"text":{"type":"string","description":"Twitter: the tweets full text"},"tweetCreated":{"type":"string","format":"date-time","description":"Twitter: the date the tweet was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"isReply":{"type":"boolean","description":"Twitter: indicates this tweet as a reply to another tweet","default":false},"isRetweet":{"type":"boolean","description":"Twitter: indicates this tweet as a 'retweet' of another tweet","default":false},"retweetParentId":{"type":"string","description":"Twitter: when the expression is a retweet, this is Twitter's id of the original tweet"},"retweetCount":{"type":"integer","format":"int32","description":"Twitter: the number of times the parent tweet was retweeted - at the time this expression was created"},"isQuotedTweet":{"type":"boolean","description":"Twitter: indicates this expression as a quoted tweet (a tweet with an addendum as the primary text)","default":false},"quotedParentId":{"type":"string","description":"Twitter: when the expression is a quoted tweet, this is Twitter's id of the original tweet (may not be immediately functional)"},"userId":{"type":"string","description":"Twitter: the expressing user's Twitter id"},"userName":{"type":"string","description":"Twitter: the user's account name for the core service"},"userScreenName":{"type":"string","description":"Twitter: the user's custom 'branding' name (allowed to change over time)"},"userTweetCount":{"type":"integer","format":"int32","description":"Twitter: the number of times this user has tweeted (includes all forms of expression replies/quotes/retweets)"},"userFollowersCount":{"type":"integer","format":"int32","description":"Twitter: the number of followers this user has at the time of this expression"},"groupTags":{"type":"array","description":"The Group Tags applied by the generating Gistener","items":{"$ref":"#/definitions/GroupTag"}},"routed":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactList":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"integer","format":"int32"},"columnNames":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"phoneColumns":{"type":"array","items":{"$ref":"#/definitions/PhoneNumberColumn"}},"importStatus":{"$ref":"#/definitions/ImportStatus"},"previewModeColumnName":{"type":"string"},"previewModeAcceptedValues":{"type":"array","items":{"type":"string"}},"size":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Annotation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string"},"location":{"type":"integer","format":"int64"},"durationMs":{"type":"integer","format":"int64"},"user":{"$ref":"#/definitions/User"},"description":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Flow":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["INBOUNDCALL","OUTBOUNDCALL","INQUEUECALL","SPEECH"]},"lockedUser":{"$ref":"#/definitions/UriReference"},"active":{"type":"boolean","default":false},"deleted":{"type":"boolean","default":false},"publishedVersion":{"$ref":"#/definitions/FlowVersion"},"checkedInVersion":{"$ref":"#/definitions/FlowVersion"},"savedVersion":{"$ref":"#/definitions/FlowVersion"},"system":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainResourceConditionNode":{"type":"object","properties":{"variableName":{"type":"string"},"operator":{"type":"string","enum":["EQ","IN","GE","GT","LE","LT"]},"operands":{"type":"array","items":{"$ref":"#/definitions/DomainResourceConditionValue"}},"conjunction":{"type":"string","enum":["AND","OR"]},"terms":{"type":"array","items":{"$ref":"#/definitions/DomainResourceConditionNode"}}}},"ContentFacetFilterItem":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST"]},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","CONTAINS"]},"values":{"type":"array","items":{"type":"string"}}}},"EdgeLogsJobFile":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"timeCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"timeModified":{"type":"string","format":"date-time","description":"The time this log file was last modified on the Edge. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"sizeBytes":{"type":"number","format":"double","description":"The size of this file in bytes."},"uploadStatus":{"type":"string","description":"The status of the upload of this file from the Edge to the cloud.  Use /upload to start an upload.","enum":["UPLOADING","NOT_UPLOADED","UPLOADED","ERROR_ON_UPLOAD"]},"edgePath":{"type":"string","format":"uri","description":"The path of this file on the Edge."},"downloadId":{"type":"string","description":"The download ID to use with the downloads API."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkItemSearchDetailsSearchResult":{"type":"object","properties":{"searchResults":{"description":"The actual results from the search","$ref":"#/definitions/LinkedEntityListingWorkItemSearchDetails"},"facetResults":{"type":"array","description":"The results from the facet requests for this search - note ALL facets will always be returned regardless of page size/starting pagenumber in the searchRequest","items":{"$ref":"#/definitions/FacetResult"}}},"description":"Contains the found elements of a search along with the facet result.  All facet results are always returned along with the searchResults regardless of page size/number."},"UserActionCategory":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkItemDetails":{"type":"object","required":["createTime","flowConfigId","flowCreateTime","flowExecId"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"workItemDefinition":{"$ref":"#/definitions/WorkItemDefinition"},"flowExecId":{"description":"The flow instance ID that created this WorkItem","$ref":"#/definitions/FlowExecId"},"flowConfigId":{"description":"The flow config ID that this workitem was created from.","$ref":"#/definitions/FlowConfigId"},"flowCreateTime":{"type":"string","format":"date-time","description":"The time the flow was started. (that created this workitem). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"createTime":{"type":"string","format":"date-time","description":"The time this workitem was started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"owner":{"description":"The user currently working on/has responsibility for this WorkItem.  May be null if no owner.","$ref":"#/definitions/User"},"offeredToUsers":{"type":"array","description":"List of users that this workItem is offered to.  May be null if only offered to queues.","items":{"$ref":"#/definitions/User"}},"offeredToQueues":{"type":"array","description":"List of queues that this workItem is offered to.  May be null if only offered to users.","items":{"$ref":"#/definitions/Queue"}},"title":{"type":"string","description":"The work item title"},"subtitle":{"type":"string","description":"The work item's subtitle - 2nd line/description"},"associatedDocuments":{"type":"array","description":"The documents associated with this workitem","items":{"$ref":"#/definitions/AssociatedDocument"}},"availableActions":{"description":"The actions that the user can take on this workitem (submit, transfer, etc).","$ref":"#/definitions/WorkItemActions"},"dataValueInfo":{"description":"The data items that provide values for any work item form elements, if applicable.","$ref":"#/definitions/DataValueInfo"},"workItemCache":{"description":"The data items in the current work item cache, if one exists.","$ref":"#/definitions/WorkItemCache"},"lastOfferedTime":{"type":"string","format":"date-time","description":"The time this work item was last offered to a user or queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"lastOwnershipUpdateTime":{"type":"string","format":"date-time","description":"The most recent time a user assumed ownership of a work item. This may be blank if the work item has no owner. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"currentTaskStartTime":{"type":"string","format":"date-time","description":"This is the time when the current task that started the work item was started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details about a WorkItem"},"ThirdPartySubscription":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"notes":{"type":"string"},"contractEffectiveDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PrimaryUserPresenceSource":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"primarySource":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContentAttributeFilterItem":{"type":"object","properties":{"id":{"type":"string"},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","CONTAINS"]},"values":{"type":"array","items":{"type":"string"}}}},"DIDPoolEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DIDPool"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PolicyErrors":{"type":"object","properties":{"policyErrorMessages":{"type":"array","items":{"$ref":"#/definitions/PolicyErrorMessage"}}}},"CallCommand":{"type":"object","properties":{"callNumber":{"type":"string"}}},"VoiceRateExtended":{"type":"object","required":["amendmentId","areaCode","currency","deletionMarker","effectiveDate","groupName","inboundTollFreeDurationIncrementSeconds","inboundTollFreeDurationMinimumSeconds","inboundTollFreeRate","inboundTolledDurationIncrementSeconds","inboundTolledDurationMinimumSeconds","inboundTolledRate","outboundDurationIncrementSeconds","outboundDurationMinimumSeconds","outboundRate","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"currency":{"type":"string","description":"The ISO 4217 currency code of the voice rate."},"amendmentId":{"type":"string","description":"The amendment Id of the voice rate."},"type":{"type":"string","description":"The voice rate type.","enum":["RATE_TOLL_FREE","RATE_TOLLED","OUTBOUND_INTERSTATE","OUTBOUND_INTRASTATE","OUTBOUND_LOCAL","EXTENDED"]},"effectiveDate":{"type":"string","format":"date-time","description":"The effective date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"groupName":{"type":"string","description":"The group containing this area code."},"areaCode":{"type":"string","description":"The area code."},"deletionMarker":{"type":"boolean","description":"The deletion marker.","default":false},"outboundRate":{"type":"number","description":"The outbound extended rate."},"outboundDurationMinimumSeconds":{"type":"integer","format":"int32","description":"The minimum duration charged in seconds."},"outboundDurationIncrementSeconds":{"type":"integer","format":"int32","description":"The billing duration increment in seconds."},"inboundTolledRate":{"type":"number","description":"The inbound tolled rate."},"inboundTolledDurationMinimumSeconds":{"type":"integer","format":"int32","description":"The minimum duration charged in seconds."},"inboundTolledDurationIncrementSeconds":{"type":"integer","format":"int32","description":"The billing duration increment in seconds."},"inboundTollFreeRate":{"type":"number","description":"The inbound toll-free rate."},"inboundTollFreeDurationMinimumSeconds":{"type":"integer","format":"int32","description":"The minimum duration charged in seconds."},"inboundTollFreeDurationIncrementSeconds":{"type":"integer","format":"int32","description":"The billing duration increment in seconds."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LineBaseEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/LineBase"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserConversationSummary":{"type":"object","properties":{"userId":{"type":"string"},"call":{"$ref":"#/definitions/MediaSummary"},"callback":{"$ref":"#/definitions/MediaSummary"},"email":{"$ref":"#/definitions/MediaSummary"},"chat":{"$ref":"#/definitions/MediaSummary"},"socialExpression":{"$ref":"#/definitions/MediaSummary"},"video":{"$ref":"#/definitions/MediaSummary"}}},"DomainEdgeSoftwareVersionDto":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"edgeVersion":{"type":"string"},"publishDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"edgeUri":{"type":"string","format":"uri"},"current":{"type":"boolean","default":false},"latestRelease":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SocialExpression":{"type":"object","properties":{"state":{"type":"string","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","NONE"]},"id":{"type":"string"},"socialMediaId":{"type":"string"},"socialMediaHub":{"type":"string"},"socialUserName":{"type":"string"},"previewText":{"type":"string"},"recordingId":{"type":"string"},"segments":{"type":"array","items":{"$ref":"#/definitions/Segment"}},"held":{"type":"boolean","default":false},"disconnectType":{"type":"string","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"startHoldTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"connectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"AgentActivityEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/AgentActivity"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EvaluationFormEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/EvaluationForm"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Template":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"integer","format":"int32"},"level":{"type":"string","enum":["GLOBAL","ORGANIZATION","USER"]},"tags":{"type":"array","items":{"type":"string"}},"data":{"type":"object","additionalProperties":{"type":"object"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkItemSearchDetails":{"type":"object","properties":{"workItem":{"$ref":"#/definitions/WorkItemDetails"}},"description":"WorkItem entry found in result to a search."},"Reservation":{"type":"object","properties":{"id":{"type":"string"},"reservedTn":{"type":"string"},"reservationExpires":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"phoneNumberType":{"type":"string","description":"The type of phone number (eg us-domestic, toll-free, etc).","enum":["TOLL_FREE","CN_DOMESTIC","US_DOMESTIC"]}}},"PublishedResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","enum":["COMPLETED","FAILED","STARTED"]},"message":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UsersEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/User"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GroupEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Group"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportSchedule":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"quartzCronExpression":{"type":"string"},"nextFireTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"description":{"type":"string"},"timeZone":{"type":"string"},"timePeriod":{"type":"string"},"interval":{"type":"string","format":"date-time","description":"Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"reportFormat":{"type":"string"},"locale":{"type":"string"},"enabled":{"type":"boolean","default":false},"reportId":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"object"}},"lastRun":{"$ref":"#/definitions/ReportRunEntry"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Facet":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"GreetingOwner":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AutomateQueue":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"The description for the queue object."},"members":{"type":"array","description":"The members for the queue object.","uniqueItems":true,"items":{"$ref":"#/definitions/User"}},"lastUpdateTime":{"type":"string","format":"date-time","description":" The last time that the queue was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"lastUpdateUser":{"description":"The user who last performed an update.","$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserRecording":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"contentUri":{"type":"string","format":"uri"},"workspace":{"$ref":"#/definitions/UriReference"},"createdBy":{"$ref":"#/definitions/UriReference"},"conversation":{"$ref":"#/definitions/Conversation"},"contentLength":{"type":"integer","format":"int64"},"durationMilliseconds":{"type":"integer","format":"int64"},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}},"read":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TagQueryRequest":{"type":"object","properties":{"query":{"type":"string"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"}}},"TextTableTransformEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ClientTextTableTransform"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactSales":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"contactPhone":{"type":"string"},"country":{"type":"string"},"title":{"type":"string"},"message":{"type":"string"},"language":{"type":"string"},"productName":{"type":"string"},"quoteId":{"type":"string"},"industry":{"type":"string"},"estimatedUsers":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowVersionConfigMetaData":{"type":"object","required":["flowDefinitionUri"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"versionSpecificComment":{"type":"string","description":"Checkin comment for this specific flow version."},"flowDefinitionUri":{"type":"string","description":"Uri location for the flow definition contents."},"createdByUser":{"description":"If known, the user who created this flow version.","$ref":"#/definitions/User"},"createdDate":{"type":"string","format":"date-time","description":"The date and time that the version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"version":{"type":"string","description":"Version of this flow config."}},"description":"Details about a specific Flow Definition version."},"SheetSchema":{"type":"object","required":["DataRow","HeaderMappings","HeaderRow","RateType","SheetNumber"],"properties":{"HeaderRow":{"type":"integer","format":"int32","description":"Row number for the XLSX sheet's headers.  This is zero indexed (i.e. 0 is row 1)."},"DataRow":{"type":"integer","format":"int32","description":"Row number of the first line of data in the sheet.  This is zero indexed (i.e. 0 is row 1)"},"HeaderMappings":{"type":"object","description":"XLSX sheet header name to object name mappings. For example, \"ROUTE_TEL_PREFIX\" to \"Prefix\" might be one such mapping.","additionalProperties":{"type":"string"}},"RateType":{"type":"string","description":"Rate type for the sheet.","enum":["INTRASTATE","INTERSTATE","INTERNATIONAL"]},"SheetNumber":{"type":"integer","format":"int32","description":"Sheet number within the XLSX file.  This is zero indexed (i.e. 0 is page 1)."},"DateFormat":{"type":"string","description":"A date format that represents the date time stamp you want to parse. This is based on the reference time of Mon Jan 2 15:04:05 MST 2006. For example, if you had the date 13-OCT-2015, this parameter should be 02-Jan-2006. As another example, if you have the date 2014-09-20, this parameter should be 2006-01-02."}}},"UnpivotColumns":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/definitions/IndexedTransform"}}}},"DomainOrganizationRole":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"defaultRoleId":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"licenses":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"permissionPolicies":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"code":{"type":"string"},"userCount":{"type":"integer","format":"int32"},"roleNeedsUpdate":{"type":"boolean","default":false},"default":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserParam":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"LanguageEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Language"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PhysicalInterfaceEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DomainPhysicalInterface"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OAuthClientEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OAuthClient"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Value":{"type":"object","properties":{"stringItems":{"type":"array","items":{"type":"string"}},"integerItems":{"type":"array","items":{"type":"string"}},"realItems":{"type":"array","items":{"type":"string"}},"dateItems":{"type":"array","items":{"type":"string","format":"date-time"}},"userItems":{"type":"array","items":{"$ref":"#/definitions/User"}},"queueItems":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"dataItems":{"type":"array","items":{"$ref":"#/definitions/SubDataItem"}}}},"CallableContactsDiagnostic":{"type":"object","properties":{"dncLists":{"type":"array","items":{"$ref":"#/definitions/UriReference"}},"callableTimeSet":{"$ref":"#/definitions/UriReference"},"ruleSets":{"type":"array","items":{"$ref":"#/definitions/UriReference"}}}},"Library":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"integer","format":"int32"},"createdBy":{"$ref":"#/definitions/User"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SpreadsheetTransform":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"restEndpoint":{"$ref":"#/definitions/TransformEndpoint"},"filenameTransforms":{"type":"array","items":{"$ref":"#/definitions/BasicTransform"}},"tags":{"type":"array","items":{"$ref":"#/definitions/TagModel"}},"sheetNameTransforms":{"type":"array","items":{"$ref":"#/definitions/IndexedTransform"}},"sheets":{"type":"array","items":{"$ref":"#/definitions/SheetTransform"}},"clientTransformModel":{"$ref":"#/definitions/ClientSpreadsheetTransform"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Detail":{"type":"object","properties":{"errorCode":{"type":"string"},"fieldName":{"type":"string"},"entityId":{"type":"string"},"entityName":{"type":"string"}}},"UserRecordingEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/UserRecording"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserActionMetadata":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"category":{"type":"string"},"deprecated":{"type":"boolean","default":false},"description":{"type":"string"},"published":{"type":"boolean","default":false},"tags":{"type":"array","items":{"type":"string"}},"helpLink":{"type":"string"},"requests":{"type":"array","items":{"$ref":"#/definitions/UserActionMetadataRequest"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Destination":{"type":"object","required":["address"],"properties":{"accountCodeDigits":{"type":"string"},"postConnectDigits":{"type":"string"},"address":{"type":"string","description":"Address or phone number."},"name":{"type":"string"},"userId":{"type":"string"},"queueId":{"type":"string"}}},"ResponseEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Response"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OAuthClient":{"type":"object","required":["authorizedGrantTypes","name","registeredRedirectUri"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the OAuth client."},"accessTokenValiditySeconds":{"type":"integer","format":"int64","description":"The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied."},"authorizedGrantTypes":{"type":"array","description":"The OAuth Grant/Client type supported by this client.","items":{"type":"string","enum":["CODE","TOKEN","SAML2BEARER","PASSWORD","CLIENT_CREDENTIALS"]}},"description":{"type":"string"},"registeredRedirectUri":{"type":"array","description":"List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback","items":{"type":"string","format":"uri"}},"secret":{"type":"string","description":"System created secret assigned to this client. Secrets are required for code authorization grants."},"roleIds":{"type":"array","description":"Roles assigned to this client. Roles only apply to clients using the client_credential grant","uniqueItems":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationForm":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"published":{"type":"boolean","default":false},"contextId":{"type":"string"},"questionGroups":{"type":"array","items":{"$ref":"#/definitions/QuestionGroup"}},"publishedVersions":{"$ref":"#/definitions/DomainEntityListingEvaluationForm"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserActionMetadataRequest":{"type":"object","properties":{"format":{"type":"string"},"method":{"type":"string"},"inputSchemaUri":{"type":"string"},"successSchemaUri":{"type":"string"},"inputSchema":{"type":"object"},"successSchema":{"type":"object"}}},"MediaResult":{"type":"object","properties":{"waveUri":{"type":"string"},"mediaUri":{"type":"string"},"waveformData":{"type":"array","items":{"type":"number","format":"float"}}}},"DomainPhysicalInterface":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"edgeUri":{"type":"string","format":"uri"},"friendlyName":{"type":"string"},"hardwareAddress":{"type":"string"},"portLabel":{"type":"string"},"physicalCapabilities":{"$ref":"#/definitions/DomainPhysicalCapabilities"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ResponseSet":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"integer","format":"int32"},"responses":{"type":"object","additionalProperties":{"$ref":"#/definitions/Reaction"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowHistoryItem":{"type":"object","required":["historyEventTime","historyEventType","success"],"properties":{"historyEventTime":{"type":"string","format":"date-time","description":"The time when the history item occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"state":{"description":"The State sequence that applies to the history event, if applicable.","$ref":"#/definitions/FlowState"},"workItem":{"description":"Information about the work item associated with the history event, if applicable.","$ref":"#/definitions/WorkItem"},"user":{"description":"The user associated with this history event, if applicable.","$ref":"#/definitions/User"},"queue":{"description":"The queue associated with this history event, if applicable.","$ref":"#/definitions/Queue"},"historyEventData":{"type":"array","description":"Data elements associated with this history event.","items":{"$ref":"#/definitions/DataItem"}},"historyEventType":{"type":"string","description":"The type of the history event being reported.","enum":["FLOW_INSTANCE_START","FLOW_INSTANCE_GOTO","FLOW_INSTANCE_TERMINATE","FLOW_INSTANCE_END","TASK_INSTANCE_START","TASK_INSTANCE_END","WORK_ITEM_INSTANCE_SAVE","WORK_ITEM_INSTANCE_ACQUIRE","WORK_ITEM_INSTANCE_SUBMIT","WORK_ITEM_INSTANCE_OFFER","WORK_ITEM_INSTANCE_REASSIGN","FLOW_INSTANCE_ERROR","FLOW_INSTANCE_RETRY"]},"success":{"type":"boolean","description":"Whether or not the flow item was successful (if a 'notification' event this will default to true)","default":false}},"description":"Information about one flow history item"},"GreetingAudioFile":{"type":"object","properties":{"durationMilliseconds":{"type":"integer","format":"int64"},"sizeBytes":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri"}}},"FacetGroup":{"type":"object","properties":{"name":{"type":"string"},"count":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/definitions/FacetItem"}}}},"UserPresenceEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/UserPresence"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Phone":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"edgeGroup":{"$ref":"#/definitions/UriReference"},"site":{"$ref":"#/definitions/UriReference"},"phoneBaseSettings":{"$ref":"#/definitions/UriReference"},"lineBaseSettings":{"$ref":"#/definitions/UriReference"},"phoneMetaBase":{"$ref":"#/definitions/UriReference"},"lines":{"type":"array","items":{"$ref":"#/definitions/Line"}},"status":{"description":"The status of the phone and lines from the primary Edge.","$ref":"#/definitions/PhoneStatus"},"secondaryStatus":{"description":"The status of the phone and lines from the secondary Edge.","$ref":"#/definitions/PhoneStatus"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"capabilities":{"$ref":"#/definitions/PhoneCapabilities"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Gateway":{"type":"object","properties":{"id":{"type":"string"},"ip":{"type":"string"},"port":{"type":"integer","format":"int32"}}},"DomainNetworkCommandResponse":{"type":"object","properties":{"correlationId":{"type":"string"},"commandName":{"type":"string"},"acknowledged":{"type":"boolean","default":false},"errorInfo":{"$ref":"#/definitions/ErrorDetails"}}},"UserLicenseAssignment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"licenseId":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"InboundRouteEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/InboundRoute"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowInputData":{"type":"object","properties":{"linkedDocumentIds":{"type":"array","description":"A list of document IDs to link with the new flow instance.","items":{"type":"string"}}},"description":"launch parameters or initializations for variables in the flow."},"VendorConnectionRequest":{"type":"object","properties":{"publisher":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}},"DeleteRetention":{"type":"object","properties":{"days":{"type":"integer","format":"int32"}}},"QueryRequest":{"type":"object","properties":{"queryPhrase":{"type":"string"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"facetNameRequests":{"type":"array","items":{"type":"string"}},"sort":{"type":"array","items":{"$ref":"#/definitions/SortItem"}},"filters":{"type":"array","items":{"$ref":"#/definitions/FacetFilterItem"}},"attributeFilters":{"type":"array","items":{"$ref":"#/definitions/AttributeFilterItem"}}}},"FaxSummary":{"type":"object","properties":{"readCount":{"type":"integer","format":"int32"},"unreadCount":{"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int32"}}},"DialerPlaceCallCommand":{"type":"object","properties":{"callId":{"type":"string"},"phoneNumber":{"type":"string"}}},"BatchReply":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/BatchReplyItem"}}}},"UserPresence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"source":{"type":"string","description":"Represents the source where the Presence was set. Some examples are: PURECLOUD, LYNC, OUTLOOK, etc."},"presenceDefinition":{"$ref":"#/definitions/OrganizationPresence"},"message":{"type":"string"},"modifiedBy":{"$ref":"#/definitions/User"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Calibration":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"calibrator":{"$ref":"#/definitions/User"},"agent":{"$ref":"#/definitions/User"},"conversation":{"$ref":"#/definitions/Conversation"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"contextId":{"type":"string"},"averageScore":{"type":"integer","format":"int32"},"highScore":{"type":"integer","format":"int32"},"lowScore":{"type":"integer","format":"int32"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"evaluations":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"scoringIndex":{"$ref":"#/definitions/Evaluation"},"expertEvaluator":{"$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowPublish":{"type":"object","required":["flowConfigVersionSource"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"flowConfigVersionSource":{"type":"string","description":"Source version that the flow was published from."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"version":{"type":"string","description":"Version of this flow config."}},"description":"Returned upon a successful publish request."},"CalibrationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Calibration"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Trace":{"type":"object","properties":{"topic":{"type":"string"},"timestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"level":{"type":"string","enum":["ERROR","WARN","INFO","DEBUG"]},"message":{"type":"string"},"details":{"type":"object"},"timestampString":{"type":"string"},"detailsString":{"type":"string"}}},"ProgressModel":{"type":"object","required":["iterationsDone","iterationsInPhase","phase"],"properties":{"phase":{"type":"string","description":"Human readable progress"},"iterationsDone":{"type":"integer","format":"int32","description":"Number of iterations performed"},"iterationsInPhase":{"type":"integer","format":"int32","description":"Approximate number of iterations to perform in this phase"}}},"CommandStatusEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/CommandStatus"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AutomateQueueMember":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContractJob":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"contract":{"$ref":"#/definitions/Contract"},"status":{"type":"string","description":"The current status of the job.","enum":["Processing","Completed","Failed"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Callback":{"type":"object","properties":{"state":{"type":"string","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","NONE"]},"id":{"type":"string"},"segments":{"type":"array","items":{"$ref":"#/definitions/Segment"}},"direction":{"type":"string","enum":["INBOUND","OUTBOUND"]},"held":{"type":"boolean","default":false},"disconnectType":{"type":"string","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"startHoldTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dialerPreview":{"$ref":"#/definitions/DialerPreview"},"callbackNumbers":{"type":"array","items":{"type":"string"}},"callbackUserName":{"type":"string"},"scriptId":{"type":"string"},"skipEnabled":{"type":"boolean","default":false},"timeoutSeconds":{"type":"integer","format":"int32"},"connectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"FlowTerminateRequest":{"type":"object","properties":{"reason":{"type":"string","description":"Reason code for a termination."}},"description":"Passed into a terminate command to customize the termination action."},"MetricThreshold":{"type":"object","properties":{"op":{"type":"string","enum":["GT","GE","LT","LE","EQ","NE"]},"value":{"type":"number","format":"double"}}},"TraceList":{"type":"object","properties":{"app":{"$ref":"#/definitions/App"},"traces":{"type":"array","items":{"$ref":"#/definitions/Trace"}}}},"FlowDetails":{"type":"object","required":["flowConfigId","launchTime","launchType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"flowConfigId":{"description":"The FlowConfigId that was used to launch this flow.","$ref":"#/definitions/FlowConfigId"},"launchTime":{"type":"string","format":"date-time","description":"The time the flow was launched. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"launchType":{"type":"string","description":"The launch mode for this flow instance.","enum":["UNKNOWN","NORMAL","TEST","AUTOMATIC"]},"launchedBy":{"description":"The user who launched the flow, if the flow was launched as the result of that user's action.","$ref":"#/definitions/User"},"status":{"type":"string","description":"The flow's running status, which indicates whether the flow is running normally or completed, etc.","enum":["UNKNOWN","RUNNING","ERROR","TERMINATED","COMPLETED"]},"associatedDocuments":{"type":"array","description":"The documents associated with this flow.","items":{"$ref":"#/definitions/AssociatedDocument"}},"flowCompletionTime":{"type":"string","format":"date-time","description":"The time the flow completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"flowCompletionReason":{"type":"string","description":"The completion reason set at the flow completion time, if applicable."},"flowErrorInfo":{"description":"Additional information if the flow is in error","$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details about the current state of a Flow Instance"},"OrgLicenseAssignment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"licenseId":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VoiceXmlOperation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","enum":["GOTO","CALL_AND_RETURN"]},"method":{"type":"string","enum":["GET","PUT","POST","DELETE"]},"encoding":{"type":"string","enum":["MULTIPART_FORM_DATA","FORM_URL_ENCODED","JSON"]},"description":{"type":"string"},"uri":{"type":"string"},"inputs":{"type":"string"},"outputs":{"type":"string"},"fetchAudio":{"type":"string"},"timeoutMS":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Edge":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"interfaces":{"type":"array","items":{"$ref":"#/definitions/EdgeInterface"}},"make":{"type":"string"},"model":{"type":"string"},"apiVersion":{"type":"string"},"softwareVersion":{"type":"string"},"softwareVersionTimestamp":{"type":"string"},"softwareVersionPlatform":{"type":"string"},"softwareVersionConfiguration":{"type":"string"},"fullSoftwareVersion":{"type":"string"},"pairingId":{"type":"string"},"fingerprint":{"type":"string"},"fingerprintHint":{"type":"string"},"currentVersion":{"type":"string"},"stagedVersion":{"type":"string"},"patch":{"type":"string"},"statusCode":{"type":"string","enum":["NEW","AWAITING_CONNECTION","AWAITING_FINGERPRINT","AWAITING_FINGERPRINT_VERIFICATION","FINGERPRINT_VERIFIED","AWAITING_BOOTSTRAP","ACTIVE","INACTIVE","RMA","UNPAIRING","UNPAIRED"]},"edgeGroup":{"$ref":"#/definitions/EdgeGroup"},"site":{"$ref":"#/definitions/UriReference"},"softwareStatus":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"},"onlineStatus":{"type":"string","enum":["ONLINE","OFFLINE"]},"serialNumber":{"type":"string"},"physicalEdge":{"type":"boolean","default":false},"managed":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ValidateAddressResponse":{"type":"object","properties":{"valid":{"type":"boolean","default":false},"response":{"$ref":"#/definitions/Response"}}},"Workspace":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","enum":["USER","GROUP"]},"isCurrentUserWorkspace":{"type":"boolean","default":false},"user":{"$ref":"#/definitions/UriReference"},"bucket":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"summary":{"$ref":"#/definitions/WorkspaceSummary"},"acl":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SessionEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Session"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ValidateAddressRequest":{"type":"object","properties":{"address":{"$ref":"#/definitions/Address"}}},"App":{"type":"object","properties":{"appId":{"type":"string"},"appVersion":{"type":"string"}}},"NocSupport":{"type":"object","properties":{"phone":{"type":"string"},"email":{"type":"string"}}},"SchemaCategoryEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/SchemaCategory"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SheetTransform":{"type":"object","properties":{"sheet":{"type":"integer","format":"int32"},"sheetName":{"type":"string"},"table":{"$ref":"#/definitions/TableTransform"}}},"CertificateDetails":{"type":"object","properties":{"issuer":{"type":"string","description":"Information about the issuer of the certificate.  The value of this property is a comma separated key=value format.  Each key is one of the attribute names supported by X.500."},"subject":{"type":"string","description":"Information about the subject of the certificate.  The value of this property is a comma separated key=value format.  Each key is one of the attribute names supported by X.500."},"expirationDate":{"type":"string","format":"date-time","description":"The expiration date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"issueDate":{"type":"string","format":"date-time","description":"The issue date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"expired":{"type":"boolean","description":"True if the certificate is expired, false otherwise.","default":false},"signatureValid":{"type":"boolean","default":false},"valid":{"type":"boolean","default":false}},"description":"Represents the details of a parsed certificate."},"RestErrorDetail":{"type":"object","properties":{"error":{"type":"string"},"details":{"type":"string"}}},"Document":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"changeNumber":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateUploaded":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"contentUri":{"type":"string","format":"uri"},"workspace":{"$ref":"#/definitions/UriReference"},"createdBy":{"$ref":"#/definitions/UriReference"},"uploadedBy":{"$ref":"#/definitions/UriReference"},"contentType":{"type":"string"},"contentLength":{"type":"integer","format":"int64"},"systemType":{"type":"string","enum":["DOCUMENT","FAX","RECORDING"]},"filename":{"type":"string"},"pageCount":{"type":"integer","format":"int64"},"read":{"type":"boolean","default":false},"callerAddress":{"type":"string"},"receiverAddress":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"tagValues":{"type":"array","items":{"$ref":"#/definitions/TagValue"}},"attributes":{"type":"array","items":{"$ref":"#/definitions/DocumentAttribute"}},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}},"uploadStatus":{"$ref":"#/definitions/UriReference"},"uploadDestinationUri":{"type":"string","format":"uri"},"uploadMethod":{"type":"string","enum":["SINGLE_PUT","MULTIPART_POST"]},"lockInfo":{"$ref":"#/definitions/LockInfo"},"acl":{"type":"array","description":"A list of permitted action rights for the user making the request","items":{"type":"string"}},"sharingStatus":{"type":"string","enum":["NONE","LIMITED","PUBLIC"]},"sharingUri":{"type":"string","format":"uri"},"downloadSharingUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"alertable":{"type":"boolean","default":false},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"type":{"type":"string","enum":["USER","SYSTEM"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IndexedTransform":{"type":"object","properties":{"replaces":{"type":"array","items":{"$ref":"#/definitions/TransformLens"}},"entityPath":{"type":"array","items":{"type":"string"}},"index":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"Endpoint":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"count":{"type":"integer","format":"int32"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"schema":{"$ref":"#/definitions/UriReference"},"enabled":{"type":"boolean","default":false},"site":{"$ref":"#/definitions/UriReference"},"dids":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExtensionPool":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"startNumber":{"type":"string","description":"The starting phone number for the range of this Extension pool. Must be in E.164 format"},"endNumber":{"type":"string","description":"The ending phone number for the range of this Extension pool. Must be in E.164 format"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AlertEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Alert"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DeltaDocument":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"filename":{"type":"string"},"contentType":{"type":"string"},"contentLengthBytes":{"type":"integer","format":"int64"},"operation":{"type":"string","enum":["CREATED","UPDATED","REPLACED","DELETED"]},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"EmailMessageListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/EmailMessage"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TermAttribute":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST"]}}},"InboundDomain":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"mxRecordStatus":{"type":"string","enum":["VALID","INVALID","NOT_AVAILABLE"]},"subDomain":{"type":"boolean","description":"Indicates if this a PureCloud sub-domain.  If true, then the appropriate DNS records are created for sending/receiving email.","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FaxDocumentEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/FaxDocument"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"HIPAAConfig":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enableIdleTokenTimeout":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactCallbackRequest":{"type":"object","properties":{"campaignId":{"type":"string"},"contactListId":{"type":"string"},"contactId":{"type":"string"},"phoneColumn":{"type":"string"},"schedule":{"type":"string"}}},"ResponseSetEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ResponseSet"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PhoneStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"operationalStatus":{"type":"string","description":"The Operational Status of this phone","enum":["OPERATIONAL","DEGRADED","OFFLINE"]},"edgesStatus":{"type":"string","description":"The status of the primary or secondary Edges assigned to the phone lines.","enum":["IN_SERVICE","MIXED_SERVICE","OUT_OF_SERVICE","NO_EDGES"]},"provision":{"description":"Provision information for this phone","$ref":"#/definitions/ProvisionInfo"},"lineStatuses":{"type":"array","description":"A list of LineStatus information for each of the lines of this phone","items":{"$ref":"#/definitions/LineStatus"}},"phoneAssignmentToEdgeType":{"type":"string","description":"The phone status's edge assignment type.","enum":["PRIMARY","SECONDARY"]},"edge":{"description":"The URI of the edge that provided this status information.","$ref":"#/definitions/UriReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DIDEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DID"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Tier":{"type":"object","properties":{"currency":{"type":"string"},"price":{"type":"number"}}},"ServiceContext":{"type":"object","properties":{"name":{"type":"string"}}},"UserSkill":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"proficiency":{"type":"number","format":"double"},"skillId":{"type":"string"},"active":{"type":"boolean","default":false}}},"Dependency":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"string"},"type":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BRIDGEACTION","COMPOSERSCRIPT","CONTACTLIST","INBOUNDCALLFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","OUTBOUNDCALLFLOW","QUEUE","SYSTEMPROMPT","USER","USERPROMPT","VOICEXML"]},"deleted":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ArchiveRetention":{"type":"object","properties":{"days":{"type":"integer","format":"int32"},"storageMedium":{"type":"string","enum":["CLOUDARCHIVE"]}}},"QueueUtilizationDiagnostic":{"type":"object","properties":{"queue":{"$ref":"#/definitions/UriReference"},"usersInQueue":{"type":"integer","format":"int32"},"activeUsersInQueue":{"type":"integer","format":"int32"},"usersOnQueue":{"type":"integer","format":"int32"},"usersNotUtilized":{"type":"integer","format":"int32"},"usersOnQueueWithStation":{"type":"integer","format":"int32"},"usersOnACampaignCall":{"type":"integer","format":"int32"},"usersOnANonCampaignCall":{"type":"integer","format":"int32"}}},"CampaignProgress":{"type":"object","properties":{"campaign":{"$ref":"#/definitions/UriReference"},"contactList":{"$ref":"#/definitions/UriReference"},"numberOfContactsCalled":{"type":"integer","format":"int64"},"totalNumberOfContacts":{"type":"integer","format":"int64"},"percentage":{"type":"integer","format":"int64"}}},"DomainNetworkAddress":{"type":"object","properties":{"type":{"type":"string"},"address":{"type":"string"},"persistent":{"type":"boolean","default":false},"family":{"type":"integer","format":"int32"}}},"DomainPermissionCollection":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"domain":{"type":"string"},"permissionMap":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/DomainPermission"}}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Participant":{"type":"object","properties":{"id":{"type":"string"},"startTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"endTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"connectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"name":{"type":"string"},"userUri":{"type":"string"},"userId":{"type":"string"},"queueId":{"type":"string"},"groupId":{"type":"string"},"queueName":{"type":"string"},"purpose":{"type":"string"},"participantType":{"type":"string"},"consultParticipantId":{"type":"string"},"address":{"type":"string"},"ani":{"type":"string"},"dnis":{"type":"string"},"locale":{"type":"string"},"wrapupRequired":{"type":"boolean","default":false},"wrapupExpected":{"type":"boolean","default":false},"wrapupPrompt":{"type":"string","enum":["MANDATORY","OPTIONAL","TIMEOUT","FORCED_TIMEOUT"]},"wrapupTimeoutMs":{"type":"integer","format":"int32"},"wrapupSkipped":{"type":"boolean","default":false},"wrapup":{"$ref":"#/definitions/Wrapup"},"monitoredParticipantId":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"calls":{"type":"array","items":{"$ref":"#/definitions/Call"}},"callbacks":{"type":"array","items":{"$ref":"#/definitions/Callback"}},"chats":{"type":"array","items":{"$ref":"#/definitions/Chat"}},"emails":{"type":"array","items":{"$ref":"#/definitions/Email"}},"socialExpressions":{"type":"array","items":{"$ref":"#/definitions/SocialExpression"}},"videos":{"type":"array","items":{"$ref":"#/definitions/Video"}},"evaluations":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}}}},"DefaultGreetingList":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"owner":{"$ref":"#/definitions/GreetingOwner"},"ownerType":{"type":"string","enum":["USER","ORGANIZATION"]},"greetings":{"type":"object","additionalProperties":{"$ref":"#/definitions/Greeting"}},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"createdBy":{"type":"string","format":"uri"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhoneMetaBaseEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Metabase"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ParsedCertificate":{"type":"object","properties":{"certificateDetails":{"type":"array","description":"The details of the certificates that were parsed correctly.","items":{"$ref":"#/definitions/CertificateDetails"}}},"description":"Represents the parsed certificate information."},"ContactListEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ContactList"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MaxParticipants":{"type":"object","properties":{"maxParticipants":{"type":"integer","format":"int32"}}},"FacetResult":{"type":"object","properties":{"requestName":{"type":"string","description":"This was the name passed in as part of the facetRequest"},"requestFieldName":{"type":"string","description":"The field name that the facet was requested for."},"fieldType":{"type":"string","description":"data type of the field being returned (if this is a mixed field this will be unknown)","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST","GROUP"]},"requestType":{"type":"string","description":"the facet request type that was made.","enum":["TERM","RANGE"]},"results":{"type":"array","items":{"$ref":"#/definitions/FacetResultItem"}}},"description":"Used as part of the searchResult to return facet results to the caller"},"HardwareRate":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"partNumber":{"type":"string"},"rate":{"$ref":"#/definitions/Rate"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SequenceSchedule":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"integer","format":"int32"},"intervals":{"type":"array","items":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"end":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}}},"timeZone":{"type":"string"},"sequence":{"$ref":"#/definitions/UriReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Group":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"memberCount":{"type":"integer","format":"int64"},"groupType":{"type":"string","enum":["OFFICIAL","DISTRIBUTION_GROUP"]},"groupImages":{"$ref":"#/definitions/GroupImages"},"groupState":{"type":"string","enum":["ACTIVE","INACTIVE","DELETED"]},"version":{"type":"number","format":"double"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainEntityListingEvaluationForm":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/EvaluationForm"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserImage":{"type":"object","properties":{"resolution":{"type":"string"},"imageUri":{"type":"string"}}},"Attribute":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"integer","format":"int32"},"description":{"type":"string"},"createdBy":{"$ref":"#/definitions/UriReference"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"$ref":"#/definitions/UriReference"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainEntityListingQueryResult":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/QueryResult"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ErrorDetails":{"type":"object","properties":{"status":{"type":"integer","format":"int32"},"message":{"type":"string"},"messageWithParams":{"type":"string"},"messageParams":{"type":"object","additionalProperties":{"type":"string"}},"code":{"type":"string"},"contextId":{"type":"string"},"nested":{"$ref":"#/definitions/ErrorDetails"},"details":{"type":"string","format":"uri"}}},"TwitterExpressionBuffer":{"type":"object","properties":{"bufferContent":{"type":"array","description":"The list of TwitterExpressions currently in the buffer.","items":{"$ref":"#/definitions/TwitterExpression"}}}},"CallableTimeSet":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"integer","format":"int32"},"callableTimes":{"type":"array","items":{"$ref":"#/definitions/CallableTime"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ResponseQueryRequest":{"type":"object","properties":{"queryPhrase":{"type":"string","description":"Query phrase to search response text and name. If not set will match all."},"pageSize":{"type":"integer","format":"int32","description":"The maximum number of hits to return. Default: 25, Maximum: 500."},"filters":{"type":"array","description":"Filter the query results.","items":{"$ref":"#/definitions/Filter"}}},"description":"Used to query for responses"},"DurationCondition":{"type":"object","properties":{"durationTarget":{"type":"string","enum":["DURATION","DURATION_RANGE"]},"durationOperator":{"type":"string"},"durationRange":{"type":"string"}}},"CsvSchema":{"type":"object","required":["DataRow","HeaderMappings","HeaderRow","Name","RateType"],"properties":{"CarrierId":{"type":"string","description":"Carrier ID associated with this CSV schema.","readOnly":true},"HeaderRow":{"type":"integer","format":"int32","description":"Row number for the CSV's headers.  This is zero indexed (i.e. 0 is row 1)."},"DataRow":{"type":"integer","format":"int32","description":"Row number of the first line of data.  This is zero indexed (i.e. 0 is row 1)."},"HeaderMappings":{"type":"object","description":"CSV header name to object name mappings. For example, \"ROUTE_TEL_PREFIX\" to \"Prefix\" might be one such mapping.","additionalProperties":{"type":"string"}},"RateType":{"type":"string","description":"Rate type for the sheet.","enum":["INTRASTATE","INTERSTATE","INTERNATIONAL"]},"Name":{"type":"string","description":"Human readable name for schema."},"DateFormat":{"type":"string","description":"A date format that represents the date time stamp you want to parse. This is based on the reference time of Mon Jan 2 15:04:05 MST 2006. For example, if you had the date 13-OCT-2015, this parameter should be 02-Jan-2006. As another example, if you have the date 2014-09-20, this parameter should be 2006-01-02."}}},"ContactListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalContact"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ConversationHistoricalQueryRequestFilter":{"type":"object","required":["operator","target","values"],"properties":{"target":{"type":"string","example":"interval","description":"Filter target","enum":["active","agentId","ani","connectedOnly","dialerCampaignId","disconnectType","dnis","duration","interval","freeText","mediaType","qualityEvaluationAgent","qualityEvaluationCriticalScore","qualityEvaluationForm","qualityEvaluationScore","qualityEvaluator","queueId","purpose","recordingRestored","wrapUpCode"]},"operator":{"type":"string","description":"Filter operator. For target 'interval' allowable values are '=', 'between', '<=', 'before', '>=', 'after'. For targets 'active', 'agentId', 'connectedOnly', 'dialerCampaignId', 'disconnectType', 'mediaType', 'purpose', 'qualityEvaluationAgent', 'qualityEvaluationForm', 'qualityEvaluator', 'queueId', 'wrapUpCode' allowable value is '='. For target 'duration' allowable values are '=', '<', '<=', '>', '>='. For targets 'ani', 'dnis', 'freeText' allowable value is 'contains'. For targets 'recordingRestored', 'qualityEvaluationCriticalScore', ', qualityEvaluationScore' no operator is required"},"values":{"type":"array","description":"Filter values. For target 'interval' with operators '=' or 'between', only 1 value is allowed in the form of 2 ISO-8601 dates separated by a '/' with no spaces. For target 'interval' with operators '<=', 'before', '>=', 'after', only 1 value is allowed in the form of 1 ISO-8601 date. For targets 'agentId', 'dialerCampaignId', 'qualityEvaluationAgent', 'qualityEvaluationForm', 'qualityEvaluator', 'queueId', 'wrapUpCode' multiple values are allowed. All values are UUIDs. For target 'disconnectType' multiple values are allowed. Values can be one of 'TRANSFER', 'CLIENT', 'REMOTE'. For target 'mediaType' multiple values are allowed. Values can be one of 'VOICE', 'CHAT', 'EMAIL'.For target 'purpose' multiple values are allowed. For targets 'active', 'connectedOnly'1 value is required and it must be either 'true' or 'false'. For target 'duration' 2 values are required for operator '='. For all other operators, 1 value is required. For targets 'ani', 'dnis', 'freeText' only a single value is allowed. For targets 'recordingRestored', 'qualityEvaluationCriticalScore', ', qualityEvaluationScore' no values are required.","items":{"type":"string"}}},"description":"Historical conversation request filter"},"FlowEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Flow"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ChannelTopic":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AgentEvaluatorActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"agent":{"$ref":"#/definitions/User"},"evaluator":{"$ref":"#/definitions/User"},"numEvaluations":{"type":"integer","format":"int32"},"averageEvaluationScore":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConsumingResourcesEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WorkItemCommand":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"}}},"ReportRunEntryEntityDomainListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ReportRunEntry"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ClientTransformModel":{"type":"object","properties":{"id":{"type":"string"},"endpointId":{"type":"string"},"filenameReplaces":{"type":"array","items":{"$ref":"#/definitions/BasicTransform"}},"tags":{"type":"array","items":{"$ref":"#/definitions/TagModel"}},"name":{"type":"string"}}},"UserActionMetadataEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"entities":{"type":"array","items":{"$ref":"#/definitions/UserActionMetadata"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactSalesResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"emailBody":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GeolocationSettings":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Call":{"type":"object","properties":{"state":{"type":"string","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","CONVERTING","UPLOADING","TRANSMITTING","NONE"]},"id":{"type":"string"},"direction":{"type":"string","enum":["INBOUND","OUTBOUND"]},"recording":{"type":"boolean","default":false},"recordingState":{"type":"string","enum":["NONE","ACTIVE","PAUSED"]},"muted":{"type":"boolean","default":false},"confined":{"type":"boolean","default":false},"held":{"type":"boolean","default":false},"recordingId":{"type":"string"},"segments":{"type":"array","items":{"$ref":"#/definitions/Segment"}},"errorInfo":{"$ref":"#/definitions/ErrorBody"},"disconnectType":{"type":"string","enum":["ENDPOINT","CLIENT","SYSTEM","TIMEOUT","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"startHoldTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"documentId":{"type":"string"},"self":{"$ref":"#/definitions/Address"},"other":{"$ref":"#/definitions/Address"},"connectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"PenetrationRate":{"type":"object","properties":{"numberOfContactsCalled":{"type":"integer","format":"int64"},"totalNumberOfContacts":{"type":"integer","format":"int64"},"percentage":{"type":"integer","format":"int64"},"penetrationRateId":{"$ref":"#/definitions/PenetrationRateId"}}},"Ticker":{"type":"object","required":["exchange","symbol"],"properties":{"symbol":{"type":"string","description":"The ticker symbol for this organization. Example: ININ, AAPL, MSFT, etc."},"exchange":{"type":"string","description":"The exchange for this ticker symbol. Examples: NYSE, FTSE, NASDAQ, etc."}}},"GreetingMediaInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"mediaFileUri":{"type":"string","format":"uri"},"mediaImageUri":{"type":"string","format":"uri"}}},"AuditEntityReference":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"},"type":{"type":"string","enum":["ATTRIBUTE","ATTRIBUTE_GROUP_INSTANCE","DOCUMENT","DOWNLOAD","FAX","GROUP","RECORDING","TAG","WORKSPACE","USER","PUBLIC","FILE","INDEX","DATABASE","PROPERTY","TEXT","THUMBNAIL"]},"action":{"type":"string"}}},"Wrapup":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"notes":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"durationSeconds":{"type":"integer","format":"int32"},"endTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"provisional":{"type":"boolean","default":false}}},"Reaction":{"type":"object","properties":{"data":{"type":"string"},"name":{"type":"string"},"reactionType":{"type":"string","enum":["HANGUP","TRANSFER","TRANSFER_FLOW","PLAY_FILE"]}}},"ChatSearchListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ChatSearchItem"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ScriptEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Script"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ChannelEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Channel"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PhonesReboot":{"type":"object","properties":{"phoneIds":{"type":"array","items":{"type":"string"}},"siteId":{"type":"string"}}},"ManagementUnitTimezone":{"type":"object","properties":{"timezone":{"type":"string"}}},"Utilization":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"utilization":{"type":"object","description":"Map of media types to utilization settings.  Map keys can be: call, chat, email, or socialExpression","additionalProperties":{"$ref":"#/definitions/OrgMediaUtilization"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkItemSubmitRequest":{"type":"object","required":["commandId"],"properties":{"commandId":{"type":"string","description":"The command associated with the submit request. Often it is the button pressed on the user interface."},"dataItems":{"type":"array","description":"The data items that should be a part of the submit request.","items":{"$ref":"#/definitions/DataItem"}}},"description":"Used as the body to the submitWorkItem request."},"ScheduleGroupEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ScheduleGroup"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Ring":{"type":"object","properties":{"expansionCriteria":{"type":"array","items":{"$ref":"#/definitions/ExpansionCriterium"}},"actions":{"$ref":"#/definitions/Actions"}}},"PhoneNumber":{"type":"object","properties":{"display":{"type":"string"},"extension":{"type":"integer","format":"int64"},"acceptsSMS":{"type":"boolean","default":false},"userInput":{"type":"string"},"e164":{"type":"string"},"countryCode":{"type":"string"}}},"PaymentMethodListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/PaymentMethod"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PaymentTokenProvider":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"tokenCreationRequestEnvelope":{"type":"object","additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PolicyEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Policy"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WrapupCode":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrganizationRoleEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationRole"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainLogicalInterface":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"edgeUri":{"type":"string","format":"uri"},"edgeAssignedId":{"type":"string"},"friendlyName":{"type":"string"},"vlanTagId":{"type":"integer","format":"int32"},"hardwareAddress":{"type":"string"},"physicalAdapterId":{"type":"string"},"ipAddress":{"type":"string"},"gateway":{"type":"string"},"primaryDns":{"type":"string"},"secondaryDns":{"type":"string"},"ifStatus":{"type":"string"},"routes":{"type":"array","items":{"$ref":"#/definitions/DomainNetworkRoute"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/DomainNetworkAddress"}},"ipv4Capabilities":{"$ref":"#/definitions/DomainCapabilities"},"ipv6Capabilities":{"$ref":"#/definitions/DomainCapabilities"},"currentState":{"type":"string","enum":["INIT","CREATING","UPDATING","OK","EXCEPTION","DELETING"]},"lastModifiedUserId":{"type":"string"},"lastModifiedCorrelationId":{"type":"string"},"commandResponses":{"type":"array","items":{"$ref":"#/definitions/DomainNetworkCommandResponse"}},"inheritPhoneTrunkBases":{"type":"boolean","description":"Phone trunk base assignment will be inherited from the Edge Group.","default":false},"useForInternalEdgeCommunication":{"type":"boolean","description":"This interface will be used for all internal edge-to-edge communication using settings from the edgeTrunkBaseAssignment on the Edge Group.","default":false},"externalTrunkBaseAssignments":{"type":"array","description":"External trunk base settings to use for external communication from this interface.","items":{"$ref":"#/definitions/TrunkBaseAssignment"}},"phoneTrunkBaseAssignments":{"type":"array","description":"Phone trunk base settings to use for phone communication from this interface.  These settings will be ignored when \"inheritPhoneTrunkBases\" is true.","items":{"$ref":"#/definitions/TrunkBaseAssignment"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowState":{"type":"object","required":["stateConfigId","stateExecId"],"properties":{"stateExecId":{"type":"string","description":"The identifier of the execution instance of this State."},"stateConfigId":{"type":"string","description":"The identifier of the definition of this State."},"stateName":{"type":"string","description":"The displayable name of this State."}},"description":"Information about the a State of a flow"},"Geolocation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","description":"A string used to describe the type of client the geolocation is being updated from e.g. ios, android, web, etc."},"primary":{"type":"boolean","description":"A boolean used to tell whether or not to set this geolocation client as the primary on a PATCH","default":false},"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"},"country":{"type":"string"},"region":{"type":"string"},"city":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ServiceEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Service"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SecurityProfile":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GroupImages":{"type":"object","properties":{"activeImages":{"type":"array","items":{"$ref":"#/definitions/UserImage"}}}},"ChannelTopicEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ChannelTopic"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DownloadResponse":{"type":"object","properties":{"contentLocationUri":{"type":"string"},"imageUri":{"type":"string"}}},"Page":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"versionId":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"rootContainer":{"type":"object","additionalProperties":{"type":"object"}},"properties":{"type":"object","additionalProperties":{"type":"object"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeSlot":{"type":"object","properties":{"startTime":{"type":"string","description":"start time in xx:xx:xx.xxx format"},"stopTime":{"type":"string","description":"stop time in xx:xx:xx.xxx format"},"day":{"type":"integer","format":"int32","description":"Day for this time slot, Monday = 1 ... Sunday = 7"}}},"ExtensionPoolEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ExtensionPool"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LineStatus":{"type":"object","properties":{"id":{"type":"string","description":"The id of this line"},"reachable":{"type":"boolean","description":"Indicates whether the edge can reach the line.","default":false},"addressOfRecord":{"type":"string","description":"The line's address of record."},"contactAddresses":{"type":"array","description":"The addresses used to contact the line.","items":{"type":"string"}},"reachableStateTime":{"type":"string","format":"date-time","description":"The time the line entered its current reachable state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"FacetKeyAttribute":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"VoicemailMailboxInfo":{"type":"object","properties":{"usageSizeBytes":{"type":"integer","format":"int64"},"totalCount":{"type":"integer","format":"int32"},"unreadCount":{"type":"integer","format":"int32"},"voicemailPolicy":{"$ref":"#/definitions/VoicemailUserPolicy"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"Permissions":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"ids":{"type":"array","items":{"type":"string"}}}},"Carrier":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"accountManager":{"$ref":"#/definitions/AccountManager"},"support":{"$ref":"#/definitions/Support"},"nocSupport":{"$ref":"#/definitions/NocSupport"},"services":{"type":"array","items":{"$ref":"#/definitions/Service"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"address":{"$ref":"#/definitions/CarrierAddress"}}},"TagModel":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"FlowConfigMetaDataEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/FlowConfigMetaData"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Occurrence":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["EVENT","SECONDS","MINUTES","INTERVALS"]}}},"QueryFacetInfo":{"type":"object","properties":{"attributes":{"type":"array","items":{"$ref":"#/definitions/FacetKeyAttribute"}},"facets":{"type":"array","items":{"$ref":"#/definitions/FacetEntry"}}}},"CallRecord":{"type":"object","properties":{"lastAttempt":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"lastResult":{"type":"string"}}},"LineEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Line"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FaxDocument":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"contentUri":{"type":"string","format":"uri"},"workspace":{"$ref":"#/definitions/UriReference"},"createdBy":{"$ref":"#/definitions/UriReference"},"contentType":{"type":"string"},"contentLength":{"type":"integer","format":"int64"},"filename":{"type":"string"},"read":{"type":"boolean","default":false},"pageCount":{"type":"integer","format":"int64"},"callerAddress":{"type":"string"},"receiverAddress":{"type":"string"},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}},"sharingUri":{"type":"string","format":"uri"},"downloadSharingUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowVersion":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"commitVersion":{"type":"string"},"configurationVersion":{"type":"string"},"type":{"type":"string","enum":["PUBLISH","CHECKIN","SAVE"]},"createdBy":{"$ref":"#/definitions/UriReference"},"configurationUri":{"type":"string"},"dateCreated":{"type":"integer","format":"int64"},"generationId":{"type":"string"},"publishResultUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PromptEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Prompt"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Evaluation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversation":{"$ref":"#/definitions/Conversation"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"evaluator":{"$ref":"#/definitions/User"},"agent":{"$ref":"#/definitions/User"},"calibration":{"$ref":"#/definitions/Calibration"},"status":{"type":"string","enum":["PENDING","INPROGRESS","FINISHED"]},"answers":{"$ref":"#/definitions/EvaluationScoringSet"},"agentHasRead":{"type":"boolean","default":false},"releaseDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"assignedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"changedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"queue":{"$ref":"#/definitions/Queue"},"resourceId":{"type":"string","description":"Only used for email evaluations. Will be null for all other evaluations."},"resourceType":{"type":"string","description":"The type of resource. Only used for email evaluations. Will be null for evaluations on all other resources.","enum":["Email"]},"redacted":{"type":"boolean","description":"Is only true when the user making the request does not have sufficient permissions to see evaluation","default":false},"isScoringIndex":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConsultTransferResponse":{"type":"object","required":["destinationParticipantId"],"properties":{"destinationParticipantId":{"type":"string","description":"Participant ID to whom the call is being transferred."}}},"DocumentAuditEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DocumentAudit"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PolicyErrorMessage":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32"},"userMessage":{"type":"object"},"userParamsMessage":{"type":"string"},"errorCode":{"type":"string"},"correlationId":{"type":"string"},"userParams":{"type":"array","items":{"$ref":"#/definitions/UserParam"}},"insertDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"LocationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Location"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Campaign":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"integer","format":"int32"},"contactList":{"$ref":"#/definitions/UriReference"},"queue":{"$ref":"#/definitions/UriReference"},"dialingMode":{"type":"string"},"script":{"$ref":"#/definitions/UriReference"},"edgeGroup":{"$ref":"#/definitions/UriReference"},"campaignStatus":{"type":"string"},"phoneColumns":{"type":"array","items":{"$ref":"#/definitions/PhoneColumn"}},"abandonRate":{"type":"number","format":"double"},"dncLists":{"type":"array","items":{"$ref":"#/definitions/UriReference"}},"callableTimeSet":{"$ref":"#/definitions/UriReference"},"callAnalysisResponseSet":{"$ref":"#/definitions/UriReference"},"errors":{"type":"array","items":{"$ref":"#/definitions/RestErrorDetail"}},"callerName":{"type":"string"},"callerAddress":{"type":"string"},"outboundLineCount":{"type":"integer","format":"int32"},"ruleSets":{"type":"array","items":{"$ref":"#/definitions/UriReference"}},"skipPreviewDisabled":{"type":"boolean","default":false},"previewTimeOutSeconds":{"type":"integer","format":"int64"},"singleNumberPreview":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GroupTag":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation date for the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date the entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"type":{"type":"string","description":"Defines which entity this Group Tag may be used for.  'ANY' for all entities.","enum":["GISTENER","SOCIALACCOUNT","ANY"]},"enabled":{"type":"boolean","description":"Indicates if this Group Tag is available for selection by other entities","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CampaignEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Campaign"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ResponseText":{"type":"object","required":["content"],"properties":{"content":{"type":"string","description":"Response text content."},"contentType":{"type":"string","description":"Response text content type."}},"description":"Contains information about the text associated with a response."},"VoicemailMessage":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"conversation":{"$ref":"#/definitions/Conversation"},"read":{"type":"boolean","default":false},"audioRecordingDurationSeconds":{"type":"integer","format":"int32"},"audioRecordingSizeBytes":{"type":"integer","format":"int64"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"callerAddress":{"type":"string"},"callerName":{"type":"string"},"callerUser":{"$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhoneCapabilities":{"type":"object","properties":{"provisions":{"type":"boolean","default":false},"registers":{"type":"boolean","default":false},"dualRegisters":{"type":"boolean","default":false},"hardwareIdType":{"type":"string"},"allowReboot":{"type":"boolean","default":false},"noRebalance":{"type":"boolean","default":false}}},"AvailableAdditionalServiceListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/AvailableAdditionalService"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Certificate":{"type":"object","required":["certificate"],"properties":{"certificate":{"type":"string","description":"The certificate to parse."}},"description":"Represents a certificate to parse."},"Action":{"type":"object","properties":{"type":{"type":"string"},"actionTypeName":{"type":"string"},"updateOption":{"type":"string"},"properties":{"type":"object","additionalProperties":{"type":"string"}}}},"VoiceRateInternational":{"type":"object","required":["amendmentId","currency","destination","durationIncrementSeconds","durationMinimumSeconds","effectiveDate","origin","rate","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"currency":{"type":"string","description":"The ISO 4217 currency code of the voice rate."},"amendmentId":{"type":"string","description":"The amendment Id of the voice rate."},"type":{"type":"string","description":"The voice rate type.","enum":["RATE_TOLL_FREE","RATE_TOLLED","OUTBOUND_INTERSTATE","OUTBOUND_INTRASTATE","OUTBOUND_LOCAL","EXTENDED"]},"effectiveDate":{"type":"string","format":"date-time","description":"The effective date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"rate":{"type":"number","description":"The rate."},"durationMinimumSeconds":{"type":"integer","format":"int32","description":"The minimum duration charged in seconds."},"durationIncrementSeconds":{"type":"integer","format":"int32","description":"The billing duration increment in seconds."},"origin":{"type":"string","description":"The origin."},"destination":{"type":"string","description":"The destination."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ReplaceRequest":{"type":"object","properties":{"changeNumber":{"type":"integer","format":"int32"},"name":{"type":"string"},"authToken":{"type":"string"}}},"EdgeInterface":{"type":"object","properties":{"type":{"type":"string"},"ipAddress":{"type":"string"},"name":{"type":"string"},"macAddress":{"type":"string"},"ifName":{"type":"string"},"endpoints":{"type":"array","items":{"$ref":"#/definitions/UriReference"}},"lineTypes":{"type":"array","items":{"type":"string","enum":["TIE","NETWORK","TRUNK","STATION"]}},"addressFamilyId":{"type":"string"}}},"PredictionResults":{"type":"object","required":["estimatedWaitTimeSeconds","formula"],"properties":{"formula":{"type":"string","description":"Indicates the estimated wait time Formula","enum":["BEST","SIMPLE","ABANDON","PATIENCEABANDON"]},"estimatedWaitTimeSeconds":{"type":"integer","format":"int32","description":"Estimated wait time in seconds"}}},"WorkspaceSummary":{"type":"object","properties":{"totalDocumentCount":{"type":"integer","format":"int64"}}},"PenetrationRateId":{"type":"object","properties":{"contactList":{"$ref":"#/definitions/UriReference"},"qualifier":{"$ref":"#/definitions/UriReference"}}},"EncryptionKey":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"createDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"keydataSummary":{"type":"string"},"user":{"$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LicensesByPermission":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"licenses":{"type":"array","items":{"$ref":"#/definitions/License"}}}},"Control":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/definitions/ControlOptions"}},"required":{"type":"boolean","default":false},"readOnly":{"type":"boolean","default":false},"variableBindingId":{"type":"string"},"type":{"type":"string","enum":["CHECKBOX","RADIO","SELECT"]}}},"WorkItemActions":{"type":"object","properties":{"canSubmit":{"type":"boolean","default":false}}},"DomainLicenseEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DomainLicense"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeLogsJobUploadRequest":{"type":"object","properties":{"fileIds":{"type":"array","items":{"type":"string"}}}},"ChatSearchItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"from":{"$ref":"#/definitions/ChatParticipant"},"to":{"$ref":"#/definitions/ChatParticipant"},"body":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConversationResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationFormAndScoringSet":{"type":"object","properties":{"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"answers":{"$ref":"#/definitions/EvaluationScoringSet"}}},"RelationshipListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Relationship"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ConnectRate":{"type":"object","properties":{"attempts":{"type":"integer","format":"int64"},"connects":{"type":"integer","format":"int64"},"connectRatio":{"type":"number","format":"double"}}},"AvailableTopicEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/AvailableTopic"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TagValueEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/TagValue"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TimeInterval":{"type":"object","properties":{"days":{"type":"integer","format":"int32"},"hours":{"type":"integer","format":"int32"}}},"OneLogin":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"certificate":{"type":"string"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Charge":{"type":"object","properties":{"licenseCount":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"price":{"type":"number"},"unitOfMeasure":{"type":"string"},"billingPeriod":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"includedUnits":{"type":"integer","format":"int32"}}},"DomainVoiceRateInternationalResponseItemEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/VoiceRateInternational"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SocialAccount":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation date for the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date the entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"enabled":{"type":"boolean","description":"Indicates if this Social Account is available for selection by other entities","default":false},"authorized":{"type":"boolean","description":"True when successfully completing the third-party authorization process","default":false},"socialHub":{"type":"string","description":"Which third party Social Media Hub this account will be communicating through"},"access_token":{"type":"string","description":"Credential provided through the Social Hub's authorization process"},"access_token_secret":{"type":"string","description":"Credential provided through the Social Hub's authorization process"},"twitterId":{"type":"string","description":"The account ID as provided by Twitter during the authorization process"},"streamingEnabled":{"type":"boolean","description":"Indicates if a stream should be opened on behalf of the indicated Social Hub account","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DependencyObject":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"string"},"type":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BRIDGEACTION","COMPOSERSCRIPT","CONTACTLIST","INBOUNDCALLFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","OUTBOUNDCALLFLOW","QUEUE","SYSTEMPROMPT","USER","USERPROMPT","VOICEXML"]},"deleted":{"type":"boolean","default":false},"consumedResources":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"consumingResources":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"View":{"type":"object","properties":{"url":{"type":"string"}}},"DomainThirdPartySubscriptionEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ThirdPartySubscription"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Quote":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"purchaseOrder":{"type":"string"},"type":{"type":"string","enum":["NEW_SUBSCRIPTION","AMENDMENT"]},"status":{"type":"string","enum":["IN_PROGRESS","SUBMITTED","FROZEN"]},"isSubmitted":{"type":"boolean","default":false},"isPending":{"type":"boolean","default":false},"isFrozen":{"type":"boolean","default":false},"currency":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"lastUpdatedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"billingContactEmail":{"type":"string"},"billingContactFirstName":{"type":"string"},"billingContactLastName":{"type":"string"},"billingContactPhone":{"type":"string"},"includeVoiceCharges":{"type":"boolean","default":false},"charges":{"type":"array","items":{"$ref":"#/definitions/QuoteCharge"}},"edgeControlModel":{"type":"string"},"referralCodes":{"type":"array","items":{"type":"string"}},"discountCodes":{"type":"array","items":{"type":"string"}},"salesPartnerCode":{"type":"string"},"isAnnualPrepay":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Extension":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"number":{"type":"string"},"owner":{"description":"A Uri reference to the owner of this extension, which is either a User or an IVR","$ref":"#/definitions/UriReference"},"extensionPool":{"$ref":"#/definitions/UriReference"},"ownerType":{"type":"string","enum":["USER","PHONE","IVR_CONFIG","GROUP"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeAllowed":{"type":"object","properties":{"timeSlots":{"type":"array","items":{"$ref":"#/definitions/TimeSlot"}},"timeZoneId":{"type":"string"},"empty":{"type":"boolean","default":false}}},"Skill":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Filter":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"operator":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}},"UserActionCategoryEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/UserActionCategory"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowHistoryResultItem":{"type":"object","required":["flowInstance"],"properties":{"flowInstance":{"description":"The flow instance information that applies to the history events.","$ref":"#/definitions/FlowDetails"},"availableActions":{"description":"The actions available for operating in the flow, with respect to your authorization identity.","$ref":"#/definitions/BackendFlowAvailableActions"},"historyItems":{"type":"array","description":"The ordered list of history events for this flow.","items":{"$ref":"#/definitions/FlowHistoryItem"}}},"description":"Information about one flow history item"},"PhoneNumberColumn":{"type":"object","properties":{"columnName":{"type":"string"},"type":{"type":"string"}}},"Alert":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"unread":{"type":"boolean","default":false},"entity":{"$ref":"#/definitions/Entity"},"metric":{"type":"string"},"metricThresholds":{"type":"array","items":{"$ref":"#/definitions/MetricThreshold"}},"metricValue":{"type":"number","format":"double"},"startTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"endTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"mediaType":{"type":"string","enum":["VOICE","CHAT"]},"statistic":{"type":"string","enum":["COUNT","SUM","AVG","RATIO"]},"ruleUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BasicTransform":{"type":"object","properties":{"replaces":{"type":"array","items":{"$ref":"#/definitions/TransformLens"}},"entityPath":{"type":"array","items":{"type":"string"}}}},"QuestionGroup":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"defaultAnswersToHighest":{"type":"boolean","default":false},"defaultAnswersToNA":{"type":"boolean","default":false},"naEnabled":{"type":"boolean","default":false},"weight":{"type":"number","format":"float"},"manualWeight":{"type":"boolean","default":false},"questions":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}}}},"DncListEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DncList"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Location":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"address":{"type":"string"},"addressFields":{"$ref":"#/definitions/LocationAddressFields"},"addressVerified":{"type":"boolean","default":false},"emergencyNumber":{"$ref":"#/definitions/LocationEmergencyNumber"},"notes":{"type":"string"},"path":{"type":"array","items":{"type":"string"}},"state":{"type":"string","description":"Current activity status of the location.","enum":["active","inactive"]},"sublocationOrder":{"type":"array","items":{"type":"string"}},"version":{"type":"number","format":"double"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Account":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"orgLegalName":{"type":"string"},"billingAddressLine1":{"type":"string"},"billingAddressLine2":{"type":"string"},"billingAddressCity":{"type":"string"},"billingAddressState":{"type":"string"},"billingAddressZipCode":{"type":"string"},"billingAddressCountry":{"type":"string"},"legalAddressLine1":{"type":"string"},"legalAddressLine2":{"type":"string"},"legalAddressCity":{"type":"string"},"legalAddressState":{"type":"string"},"legalAddressZipCode":{"type":"string"},"legalAddressCountry":{"type":"string"},"billingContactFirstName":{"type":"string"},"billingContactLastName":{"type":"string"},"billingContactEmail":{"type":"string"},"billingContactPhone":{"type":"string"},"purchaseOrderNumber":{"type":"string"},"isTaxExempt":{"type":"boolean","default":false},"currency":{"type":"string"},"paymentTerm":{"type":"string"},"contractTerm":{"type":"integer","format":"int32"},"autoRenew":{"type":"boolean","default":false},"enabled":{"type":"boolean","default":false},"minCommitQuantities":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"estimatedQuantities":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"oneTimeCharges":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkItemDefinition":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The configuration ID for this workItem"},"name":{"type":"string"},"commandCategories":{"type":"array","description":"The commands that can be performed on this work item","items":{"$ref":"#/definitions/WorkItemCommandGroup"}},"form":{"description":"The simple work item form containging the control to present for this work item","$ref":"#/definitions/Form"}}},"Invoice":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"invoiceNumber":{"type":"string"},"invoiceDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dueDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"amount":{"type":"string"},"balance":{"type":"string"},"status":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainPermissionPolicy":{"type":"object","properties":{"domain":{"type":"string"},"entityName":{"type":"string"},"policyName":{"type":"string"},"policyDescription":{"type":"string"},"actionSet":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"namedResources":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"allowConditions":{"type":"boolean","default":false},"resourceConditionNode":{"$ref":"#/definitions/DomainResourceConditionNode"}}},"KeyRotationSchedule":{"type":"object","required":["period"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"period":{"type":"string","description":"Value to set schedule to","enum":["DISABLED","DAILY","WEEKLY","MONTHLY","YEARLY"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Support":{"type":"object","properties":{"phone":{"type":"string"},"email":{"type":"string"},"website":{"type":"string"}}},"WorkspaceCreate":{"type":"object","properties":{"name":{"type":"string"},"bucket":{"type":"string"}}},"QualityAuditPage":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/QualityAudit"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ResponseQueryResults":{"type":"object","required":["results"],"properties":{"results":{"description":"Contains the query results","$ref":"#/definitions/ResponseEntityList"}},"description":"Used to return response query results"},"SchemaReferenceEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DomainSchemaReference"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SocializeEntityFilter":{"type":"object","properties":{"fieldName":{"type":"string","description":"The fieldName the filter will be applied to."},"operator":{"type":"string","description":"The operator to apply when filtering.","enum":["EQ","NEG_EQ","CONTAINS","NEG_CONTAINS","STARTS_WITH","NEG_STARTS_WITH","ENDS_WITH","NEG_ENDS_WITH","BT","GT","LT","GE","LE","IN"]},"fieldValue":{"type":"string","description":"The value to filter on."}}},"SortItem":{"type":"object","properties":{"name":{"type":"string"},"ascending":{"type":"boolean","default":false}}},"OrganizationPresenceEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OrganizationPresence"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DependencyStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"buildId":{"type":"string"},"dateStarted":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateCompleted":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"status":{"type":"string","enum":["BUILDINITIALIZING","BUILDINPROGRESS","NOTBUILT","OPERATIONAL","OPERATIONALNEEDSREBUILD"]},"failedObjects":{"type":"array","items":{"$ref":"#/definitions/FailedObject"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ShareEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Share"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"QueueMemberEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ServiceType":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"codecs":{"type":"array","items":{"type":"string"}},"strip":{"type":"string","description":"Prefix striping is a mechanism to remove digits from the beginning of a phone number before sending a call out to a carrier, such as international exit codes. This must be configurable on a per carrier basis as all carriers act differently."},"callingPartyId":{"type":"string"},"callHistory":{"type":"string"},"prefix":{"type":"string"}}},"CommonAuditRequest":{"type":"object","properties":{"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"sortBy":{"type":"array","items":{"$ref":"#/definitions/SortBy"}},"queryPhrase":{"type":"string"},"queryFields":{"type":"array","items":{"type":"string"}},"facets":{"type":"array","items":{"$ref":"#/definitions/Facet"}},"filters":{"type":"array","items":{"$ref":"#/definitions/Filter"}}}},"EdgeAutoUpdateConfig":{"type":"object","properties":{"timeZone":{"type":"string"},"rrule":{"type":"string"},"start":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"end":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"DocumentAudit":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/UriReference"},"workspace":{"$ref":"#/definitions/UriReference"},"transactionId":{"type":"string"},"transactionInitiator":{"type":"boolean","default":false},"application":{"type":"string"},"serviceName":{"type":"string"},"level":{"type":"string","enum":["USER","SYSTEM"]},"timestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"status":{"type":"string","enum":["SUCCESS","FAILURE"]},"actionContext":{"type":"string","enum":["CREATE","READ","UPDATE","DELETE","DOWNLOAD","VIEW","UPLOAD","SAVE","MOVE","COPY","ADD","REMOVE","RECEIVE","CONVERT","FAX","CREATE_COVERPAGE","USER_ADD","USER_REMOVE","MEMBER_ADD","MEMBER_REMOVE","MEMBER_UPDATE","TAG_ADD","TAG_REMOVE","TAG_UPDATE","ATTRIBUTE_ADD","ATTRIBUTE_REMOVE","ATTRIBUTE_UPDATE","ATTRIBUTE_GROUP_INSTANCE_ADD","ATTRIBUTE_GROUP_INSTANCE_REMOVE","ATTRIBUTE_GROUP_INSTANCE_UPDATE","INDEX_SAVE","INDEX_DELETE","INDEX_CREATE","FILE_SAVE","FILE_DELETE","FILE_READ","THUMBNAIL_CREATE","TEXT_EXTRACT","SHARE_ADD","SHARE_REMOVE","VERSION_CREATE"]},"action":{"type":"string","enum":["CREATE","READ","UPDATE","DELETE","DOWNLOAD","VIEW","UPLOAD","SAVE","MOVE","COPY","ADD","REMOVE","RECEIVE","CONVERT","FAX","CREATE_COVERPAGE","USER_ADD","USER_REMOVE","MEMBER_ADD","MEMBER_REMOVE","MEMBER_UPDATE","TAG_ADD","TAG_REMOVE","TAG_UPDATE","ATTRIBUTE_ADD","ATTRIBUTE_REMOVE","ATTRIBUTE_UPDATE","ATTRIBUTE_GROUP_INSTANCE_ADD","ATTRIBUTE_GROUP_INSTANCE_REMOVE","ATTRIBUTE_GROUP_INSTANCE_UPDATE","INDEX_SAVE","INDEX_DELETE","INDEX_CREATE","FILE_SAVE","FILE_DELETE","FILE_READ","THUMBNAIL_CREATE","TEXT_EXTRACT","SHARE_ADD","SHARE_REMOVE","VERSION_CREATE"]},"entity":{"$ref":"#/definitions/AuditEntityReference"},"changes":{"type":"array","items":{"$ref":"#/definitions/AuditChange"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainCertificateAuthority":{"type":"object","required":["certificate","services","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"certificate":{"type":"string","description":"The authorities signed X509 PEM encoded certificate."},"type":{"type":"string","description":"The certificate authorities type.  Managed certificate authorities are generated and maintained by Interactive Intelligence.  These are read-only and not modifiable by clients.  Remote authorities are customer managed.","enum":["MANAGED","REMOTE"]},"services":{"type":"array","description":"The service(s) that the authority can be used to authenticate.","items":{"type":"string","enum":["SIP","PROVISION","PROVISION_PHONE"]}},"certificateDetails":{"type":"array","description":"The details of the parsed certificate(s).","items":{"$ref":"#/definitions/CertificateDetails"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A certificate authority represents an organization that has issued a digital certificate for making secure connections with an edge device."},"IVREntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/IVR"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DialerAuditRequest":{"type":"object","properties":{"queryPhrase":{"type":"string"},"queryFields":{"type":"array","items":{"type":"string"}},"facets":{"type":"array","items":{"$ref":"#/definitions/Facet"}},"filters":{"type":"array","items":{"$ref":"#/definitions/Filter"}}}},"SystemPrompt":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"resources":{"type":"array","items":{"$ref":"#/definitions/SystemPromptAsset"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IntegrationType":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"provider":{"type":"string","enum":["BRIDGE","WEBHOOKS","REALTIME"]},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowConfigMetaData":{"type":"object","required":["flowType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"configState":{"type":"string","description":"Usability of this flow definition. (output only)","enum":["UNKNOWN","ACTIVE","INACTIVE","DELETED"]},"flowType":{"type":"string","description":"Type of flow this definition describes","enum":["UNKNOWN","WORKFLOW"]},"lockedByUser":{"description":"If locked for editing, the user who locked this definition, otherwise null","$ref":"#/definitions/User"},"newestPublishedVersion":{"type":"string","description":"The most recently published version (output only)"},"newestVersion":{"type":"string","description":"The most recent version, regardless of published state (output only)"},"associatedWorkspaces":{"type":"array","description":"Workspaces associated with this flow.","items":{"$ref":"#/definitions/Workspace"}},"description":{"type":"string","description":"User notes describing the flow definition."},"hasDraft":{"type":"boolean","description":"Flag if this definition has a draft populated.","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details about the current state of a Flow Definition"},"EndpointEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Endpoint"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PublishScriptRequestData":{"type":"object","properties":{"scriptId":{"type":"string"},"versionId":{"type":"string"}}},"Bullseye":{"type":"object","properties":{"rings":{"type":"array","items":{"$ref":"#/definitions/Ring"}}}},"CreateCallbackCommand":{"type":"object","properties":{"scriptId":{"type":"string"},"queueId":{"type":"string"},"callbackUserName":{"type":"string"},"callbackNumbers":{"type":"array","items":{"type":"string"}},"countryCode":{"type":"string"},"skipEnabled":{"type":"boolean","default":false}}},"PhoneBase":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"phoneMetaBase":{"$ref":"#/definitions/UriReference"},"lines":{"type":"array","items":{"$ref":"#/definitions/LineBase"}},"properties":{"type":"object","additionalProperties":{"type":"object"}},"capabilities":{"$ref":"#/definitions/PhoneCapabilities"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TransformLens":{"type":"object","properties":{"replace":{"type":"string"},"value":{"type":"string"}}},"PhoneNumberStatus":{"type":"object","properties":{"callable":{"type":"boolean","default":false}}},"DocumentThumbnail":{"type":"object","properties":{"resolution":{"type":"string"},"imageUri":{"type":"string"}}},"Station":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["AVAILABLE","ASSOCIATED"]},"userId":{"type":"string"},"primaryEdge":{"$ref":"#/definitions/UriReference"},"secondaryEdge":{"$ref":"#/definitions/UriReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AttributeQueryRequest":{"type":"object","properties":{"query":{"type":"string","description":"Query phrase to search attribute by name. If not set will match all."},"pageSize":{"type":"integer","format":"int32","description":"The maximum number of hits to return. Default: 25, Maximum: 500."},"pageNumber":{"type":"integer","format":"int32","description":"The page number to start at. The first page is number 1."}},"description":"Used to query for attributes"},"OrphanRecordingListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OrphanRecording"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DependencyObjectEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DependencyObject"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OutboundRouteEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OutboundRoute"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CommandStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"expiration":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"userId":{"type":"string"},"statusCode":{"type":"string","enum":["INPROGRESS","COMPLETE","ERROR","CANCELING","CANCELED"]},"commandType":{"type":"string","enum":["UPLOAD","COPYDOCUMENT","MOVEDOCUMENT","DELETEWORKSPACE","DELETEDOCUMENT","DELETETAG","UPDATETAG","REINDEX","CLEANUP","REPLACEDOCUMENT"]},"document":{"$ref":"#/definitions/Document"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Rule":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"order":{"type":"integer","format":"int32"},"category":{"type":"string"},"conditions":{"type":"array","items":{"$ref":"#/definitions/Condition"}},"actions":{"type":"array","items":{"$ref":"#/definitions/Action"}}}},"Contract":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"quote":{"$ref":"#/definitions/Quote"},"signerUrl":{"type":"string"},"job":{"$ref":"#/definitions/ContractJob"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallForwarding":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"enabled":{"type":"boolean","default":false},"phoneNumber":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Site":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"primarySites":{"type":"array","items":{"$ref":"#/definitions/UriReference"}},"secondarySites":{"type":"array","items":{"$ref":"#/definitions/UriReference"}},"primaryEdges":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"secondaryEdges":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/OrganizationAddress"}},"edges":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"edgeAutoUpdateConfig":{"description":"Recurrance rule, time zone, and start/end settings for automatic edge updates for this site","$ref":"#/definitions/EdgeAutoUpdateConfig"},"location":{"$ref":"#/definitions/UriReference"},"managed":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SiteEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Site"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainBillingPeriodEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/BillingPeriod"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DncList":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"integer","format":"int32"},"phoneNumberColumns":{"type":"array","items":{"type":"string"}},"importStatus":{"$ref":"#/definitions/ImportStatus"},"fileKey":{"type":"string"},"size":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EstimatedWaitTimePredictions":{"type":"object","required":["results"],"properties":{"results":{"type":"array","description":"Returned upon a successful estimated wait time request.","items":{"$ref":"#/definitions/PredictionResults"}}}},"CreateTemplateFromScriptRequestData":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"scriptId":{"type":"string"},"userId":{"type":"string"}}},"ChatParticipant":{"type":"object","properties":{"type":{"type":"string","enum":["USER","ROOM"]}}},"DataValueInfo":{"type":"object","properties":{"dataItems":{"type":"array","items":{"$ref":"#/definitions/DataItem"}}}},"QueryResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"body":{"$ref":"#/definitions/DomainEntity"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ParticipantRequest":{"type":"object","properties":{"id":{"type":"string"},"wrapup":{"$ref":"#/definitions/Wrapup"},"state":{"type":"string","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","NONE"]},"recording":{"type":"boolean","default":false},"muted":{"type":"boolean","default":false},"confined":{"type":"boolean","default":false},"held":{"type":"boolean","default":false},"wrapupSkipped":{"type":"boolean","default":false}}},"LogicalInterfaceEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DomainLogicalInterface"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportMetaDataEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ReportMetaData"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowLaunchRequest":{"type":"object","required":["flowConfigId","launchType"],"properties":{"flowConfigId":{"description":"ID of the flow to launch, will launch the most recently published version if a specific version is not specified.","$ref":"#/definitions/FlowConfigId"},"flowInstanceName":{"type":"string","description":"The displayable instance name to assign to the new flow instance (or omit to have one automatically generated)"},"inputData":{"description":"contains launch parameters or initializations for variables in the flow.","$ref":"#/definitions/FlowInputData"},"launchType":{"type":"string","description":"launch type of the flow - NORMAL or TEST","enum":["UNKNOWN","NORMAL","TEST","AUTOMATIC"]}},"description":"Passed into a flow to describe an object to launch and returned from the operation with the Id populated with the flowInstance launched."},"LocationAddressFields":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"countryName":{"type":"string"},"state":{"type":"string"},"street1":{"type":"string"},"street2":{"type":"string"},"zipcode":{"type":"string"}}},"Chat":{"type":"object","properties":{"jabberId":{"type":"string"}}},"EvaluationQueryRequest":{"type":"object","properties":{"conversationId":{"type":"string"},"userType":{"type":"string","enum":["EVALUATOR","AGENT"]},"currentUserId":{"type":"string"},"agentId":{"type":"string"},"queueId":{"type":"string"},"interval":{"type":"string"},"evaluationState":{"type":"array","items":{"type":"string","enum":["PENDING","INPROGRESS","FINISHED"]}},"isReleased":{"type":"boolean","default":false},"agentHasRead":{"type":"boolean","default":false},"expandAnswerTotalScores":{"type":"boolean","default":false},"maximum":{"type":"integer","format":"int32"}}},"BatchCommand":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/BatchItem"}},"commandId":{"type":"string"}}},"NumberOrderRequest":{"type":"object","properties":{"orderTns":{"type":"array","items":{"type":"string"}},"reservationIds":{"type":"array","items":{"type":"string"}},"orderId":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"phoneNumberType":{"type":"string","description":"The type of phone number (eg us-domestic, toll-free, etc), to determine which third-party api(s) to use for the order request.","enum":["TOLL_FREE","CN_DOMESTIC","US_DOMESTIC"]}}},"SkillEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Skill"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowExecId":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"ID of a running flow instance."},"CreateShareRequestMember":{"type":"object","properties":{"memberType":{"type":"string","enum":["USER","PUBLIC"]},"member":{"$ref":"#/definitions/Entity"}}},"ExternalContact":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"},"salutation":{"type":"string"},"title":{"type":"string"},"workPhone":{"$ref":"#/definitions/PhoneNumber"},"cellPhone":{"$ref":"#/definitions/PhoneNumber"},"homePhone":{"$ref":"#/definitions/PhoneNumber"},"otherPhone":{"$ref":"#/definitions/PhoneNumber"},"workEmail":{"type":"string"},"personalEmail":{"type":"string"},"otherEmail":{"type":"string"},"address":{"$ref":"#/definitions/Address"},"modifyDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"createDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"externalOrganization":{"$ref":"#/definitions/ExternalOrganization"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ResourceConditionValue":{"type":"object","properties":{"type":{"type":"string","enum":["SCALAR","VARIABLE","USER","QUEUE"]},"value":{"type":"string"}}},"TransformEndpoint":{"type":"object","required":["ready"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"swaggerUrl":{"type":"string","description":"The Url to the swagger documentation of the endpoint where parsed entities will be posted"},"route":{"type":"string","description":"The swagger route to use"},"entity":{"type":"string","description":"The entity type being posted"},"apiFunction":{"type":"string","description":"The swagger function being called"},"ready":{"type":"boolean","description":"Whether this TransformEndpoint has been configured to work (security groups, permissions, etc)","default":false},"active":{"type":"boolean","description":"Whether this TransformEndpoint is currently active and accepting transformation operations","default":false},"batchSize":{"type":"integer","format":"int32","description":"The number of entities to send in an array for batch POSTs, or 0 for unbatched POSTs"},"parallelism":{"type":"integer","format":"int32","description":"The number of parallel POSTs to allow at once"},"updateProgressEvery":{"type":"integer","format":"int32","description":"The swagger route to use"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowDetailsSearchResult":{"type":"object","properties":{"searchResults":{"description":"The actual results from the search","$ref":"#/definitions/LinkedEntityListingFlowDetails"},"facetResults":{"type":"array","description":"The results from the facet requests for this search - note ALL facets will always be returned regardless of page size/starting pagenumber in the searchRequest","items":{"$ref":"#/definitions/FacetResult"}}},"description":"Contains the found elements of a search along with the facet result.  All facet results are always returned along with the searchResults regardless of page size/number."},"RetentionDuration":{"type":"object","properties":{"archiveRetention":{"$ref":"#/definitions/ArchiveRetention"},"deleteRetention":{"$ref":"#/definitions/DeleteRetention"}}},"TransformProgress":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"service":{"type":"string","description":"Name of this service"},"user":{"description":"User unique identifier","$ref":"#/definitions/User"},"uploadTime":{"type":"string","format":"date-time","description":"Time when file was uploaded. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"filename":{"type":"string","description":"Name of the file being parsed"},"tags":{"type":"array","description":"Tag matching for searching transformation schemas in use","items":{"$ref":"#/definitions/TagModel"}},"progress":{"description":"State of parsing progress for this upload transformation","$ref":"#/definitions/ProgressModel"},"model":{"description":"ID of the ratesheet","$ref":"#/definitions/TransformModel"},"errors":{"type":"array","description":"Errors encountered during parsing","items":{"$ref":"#/definitions/ErrorBody"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QueryResults":{"type":"object","properties":{"results":{"$ref":"#/definitions/DomainEntityListingQueryResult"},"facetInfo":{"$ref":"#/definitions/QueryFacetInfo"}}},"ColumnCollapse":{"type":"object","properties":{"label":{"type":"string"},"columns":{"type":"array","items":{"type":"integer","format":"int32"}}}},"PhoneColumn":{"type":"object","properties":{"columnName":{"type":"string"},"type":{"type":"string"}}},"Metabase":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LinkedEntityListingFlowDetails":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/FlowDetails"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeVersionInformation":{"type":"object","properties":{"softwareVersion":{"type":"string"}}},"StationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Station"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Prompt":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"resources":{"type":"array","items":{"$ref":"#/definitions/PromptAsset"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Recording":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversationId":{"type":"string"},"path":{"type":"string"},"startTime":{"type":"string"},"endTime":{"type":"string"},"media":{"type":"string"},"mediaUri":{"type":"string"},"waveUri":{"type":"string"},"annotations":{"type":"array","items":{"$ref":"#/definitions/Annotation"}},"transcript":{"type":"array","items":{"$ref":"#/definitions/ChatMessage"}},"emailTranscript":{"type":"array","items":{"$ref":"#/definitions/EmailMessage"}},"fileState":{"type":"string","enum":["ARCHIVED","AVAILABLE","DELETED","RESTORED","RESTORING","UPLOADING"]},"restoreExpirationTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"mediaUris":{"type":"object","additionalProperties":{"$ref":"#/definitions/MediaResult"}},"estimatedTranscodeTimeMs":{"type":"integer","format":"int64"},"actualTranscodeTimeMs":{"type":"integer","format":"int64"},"archiveDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"archiveMedium":{"type":"string","enum":["CLOUDARCHIVE"]},"deleteDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"maxAllowedRestorationsForOrg":{"type":"integer","format":"int32"},"remainingRestorationsAllowedForOrg":{"type":"integer","format":"int32"},"recordingId":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Tag":{"type":"object","properties":{"label":{"type":"string"},"interactionFlag":{"type":"boolean","default":false}}},"FlowReportResultItem":{"type":"object","required":["currentState","flowConfigId","flowExecId","startDateTime"],"properties":{"flowExecId":{"description":"The flow instance ID for this process","$ref":"#/definitions/FlowExecId"},"flowConfigId":{"description":"The flow config ID that this workitem was created from.","$ref":"#/definitions/FlowConfigId"},"flowInstanceName":{"type":"string","description":"The instance name for this flow in relation to its primary document.  If the flow is not a document-centric type, this value will be empty."},"associatedDocument":{"description":"the document for this flow (if this flow was launched via a document)","$ref":"#/definitions/AssociatedDocument"},"flowStatus":{"type":"string","description":"The flow's running status, which indicates whether the flow is running normally or in error, etc;","enum":["UNKNOWN","RUNNING","ERROR","TERMINATED","COMPLETED"]},"currentState":{"type":"string","description":"The current state of the flow (EG what action is being processed)"},"startDateTime":{"type":"string","format":"date-time","description":"The time the flow was started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"endDateTime":{"type":"string","format":"date-time","description":"The time the flow ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"workItemUserAssignees":{"type":"array","description":"List of users currently assigned to a workItem","items":{"$ref":"#/definitions/User"}},"completedUser":{"description":"User that completed the flow","$ref":"#/definitions/User"},"completionReason":{"type":"string","description":"Reason for completion"},"flowErrorInfo":{"description":"Additional information if the flow is in error","$ref":"#/definitions/ErrorBody"}},"description":"Report for one active (running) process found in result to a report request."},"Share":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"sharedEntityType":{"type":"string","enum":["DOCUMENT"]},"sharedEntity":{"$ref":"#/definitions/UriReference"},"memberType":{"type":"string","enum":["USER","PUBLIC"]},"member":{"$ref":"#/definitions/UriReference"},"sharedBy":{"$ref":"#/definitions/UriReference"},"workspace":{"$ref":"#/definitions/UriReference"},"user":{"$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MediaSummary":{"type":"object","properties":{"contactCenter":{"type":"integer","format":"int32"},"enterprise":{"type":"integer","format":"int32"}}},"Policy":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"order":{"type":"integer","format":"int32"},"description":{"type":"string"},"enabled":{"type":"boolean","default":false},"mediaPolicies":{"description":"Conditions and actions per media type","$ref":"#/definitions/MediaPolicies"},"conditions":{"description":"Conditions","$ref":"#/definitions/PolicyConditions"},"actions":{"description":"Actions","$ref":"#/definitions/PolicyActions"},"policyErrors":{"$ref":"#/definitions/PolicyErrors"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"directions":{"type":"array","items":{"type":"string","enum":["INBOUND","OUTBOUND"]}},"dateRanges":{"type":"array","items":{"type":"string"}},"mediaTypes":{"type":"array","items":{"type":"string","enum":["CALL","CHAT"]}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"duration":{"$ref":"#/definitions/DurationCondition"},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"}}},"FacetStatistics":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"min":{"type":"number","format":"double"},"max":{"type":"number","format":"double"},"mean":{"type":"number","format":"double"},"stdDeviation":{"type":"number","format":"double"},"dateMin":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateMax":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"SecurityProfileEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/SecurityProfile"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DataItem":{"type":"object","required":["parameterName","parameterType"],"properties":{"parameterName":{"type":"string","description":"The name of the data element associated with a history event."},"parameterType":{"type":"string","description":"The type of the data element associated with a history event."},"parameterValues":{"description":"The values of the data element associated with a history event.","$ref":"#/definitions/Value"}},"description":"Data elements associated with a history event"},"FavoriteTemplateRequestData":{"type":"object","properties":{"templateId":{"type":"string"}}},"ExternalOrganization":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"companyType":{"type":"string"},"industry":{"type":"string"},"primaryContactId":{"type":"string"},"address":{"$ref":"#/definitions/Address"},"phoneNumber":{"$ref":"#/definitions/PhoneNumber"},"faxNumber":{"$ref":"#/definitions/PhoneNumber"},"employeeCount":{"type":"integer","format":"int64"},"revenue":{"type":"integer","format":"int64"},"tags":{"type":"array","items":{"type":"string"}},"websites":{"type":"array","items":{"type":"string"}},"tickers":{"type":"array","items":{"$ref":"#/definitions/Ticker"}},"modifyDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"createDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VoiceRateInternationalEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/VoiceRateExtended"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AccountStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"orgName":{"type":"string"},"configured":{"type":"boolean","default":false},"adminUIURL":{"type":"string"},"thirdPartyAccountId":{"type":"string"},"thirdPartySubscriptionId":{"type":"string"},"thirdPartySubscriptionNonAcbId":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrganizationProductEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationProduct"}},"pageCount":{"type":"integer","format":"int32"}}},"DomainThirdPartyAccountEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ThirdPartyAccount"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DeltaRequest":{"type":"object","properties":{"contextToken":{"type":"string"}}},"InboundDomainEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/InboundDomain"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FailedObject":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"name":{"type":"string"},"errorCode":{"type":"string"}}},"VoicemailMessageEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/VoicemailMessage"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"InboundRoute":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"pattern":{"type":"string","description":"The search pattern that the mailbox name should match."},"queue":{"description":"The queue to route the emails to.","$ref":"#/definitions/UriReference"},"priority":{"type":"integer","format":"int32","description":"The priority to use for routing."},"skills":{"type":"array","description":"The skills to use for routing.","items":{"$ref":"#/definitions/UriReference"}},"language":{"description":"The language to use for routing.","$ref":"#/definitions/UriReference"},"fromName":{"type":"string","description":"The sender name to use for outgoing replies."},"fromEmail":{"type":"string","description":"The sender email to use for outgoing replies."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentAttribute":{"type":"object","properties":{"attribute":{"$ref":"#/definitions/Attribute"},"values":{"type":"array","items":{"type":"string"}}}},"ConversationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Conversation"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Order":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"quote":{"$ref":"#/definitions/Quote"},"envelopeId":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VoiceRate":{"type":"object","required":["amendmentId","currency","durationIncrementSeconds","durationMinimumSeconds","effectiveDate","rate","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"currency":{"type":"string","description":"The ISO 4217 currency code of the voice rate."},"amendmentId":{"type":"string","description":"The amendment Id of the voice rate."},"type":{"type":"string","description":"The voice rate type.","enum":["RATE_TOLL_FREE","RATE_TOLLED","OUTBOUND_INTERSTATE","OUTBOUND_INTRASTATE","OUTBOUND_LOCAL","EXTENDED"]},"effectiveDate":{"type":"string","format":"date-time","description":"The effective date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"rate":{"type":"number","description":"The rate."},"durationMinimumSeconds":{"type":"integer","format":"int32","description":"The minimum duration charged in seconds."},"durationIncrementSeconds":{"type":"integer","format":"int32","description":"The billing duration increment in seconds."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Script":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"versionId":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"publishedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"versionDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"startPageId":{"type":"string"},"startPageName":{"type":"string"},"features":{"type":"object"},"variables":{"type":"object"},"customActions":{"type":"object"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmailMessage":{"type":"object","properties":{"htmlBody":{"type":"string"},"textBody":{"type":"string"},"id":{"type":"string"},"to":{"type":"array","items":{"$ref":"#/definitions/EmailAddress"}},"cc":{"type":"array","items":{"$ref":"#/definitions/EmailAddress"}},"bcc":{"type":"array","items":{"$ref":"#/definitions/EmailAddress"}},"from":{"$ref":"#/definitions/EmailAddress"},"subject":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/definitions/EmailAttachment"}},"time":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"UrlResponse":{"type":"object","properties":{"url":{"type":"string"}}},"Channel":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"connectUri":{"type":"string","format":"uri"}}},"QuestionScore":{"type":"object","properties":{"questionId":{"type":"string"},"answerId":{"type":"string"},"score":{"type":"integer","format":"int32"},"markedNA":{"type":"boolean","default":false},"failedKillQuestion":{"type":"boolean","default":false},"comments":{"type":"string"}}},"DocumentUpload":{"type":"object","properties":{"name":{"type":"string"},"workspace":{"$ref":"#/definitions/UriReference"},"tags":{"type":"array","items":{"type":"string"}},"tagIds":{"type":"array","items":{"type":"string"}}}},"EdgeLogsJob":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"files":{"type":"array","description":"The files available to upload from the Edge to the cloud.","items":{"$ref":"#/definitions/EdgeLogsJobFile"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SystemPromptEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/SystemPrompt"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ConsumedResourcesEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LineBase":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"lineMetaBase":{"$ref":"#/definitions/UriReference"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AvailableAdditionalService":{"type":"object","required":["availableForProducts","defaultForProducts","description","exclusiveFromProducts","partNumber","rate","requiredForProducts"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"The description of this additional service."},"partNumber":{"type":"string","description":"The part number of this additional service."},"requiredForProducts":{"type":"array","description":"The list of products which require this additional service.","items":{"type":"string"}},"availableForProducts":{"type":"array","description":"The list of products for which this additional service is available.","items":{"type":"string"}},"defaultForProducts":{"type":"array","description":"The list of products which have this additional service by default.","items":{"type":"string"}},"exclusiveFromProducts":{"type":"array","description":"The list of additional services which are not compatible with this additional service.","items":{"type":"string"}},"rate":{"description":"The rate of this additional service.","$ref":"#/definitions/Rate"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainCapabilities":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"dhcp":{"type":"boolean","default":false},"metric":{"type":"integer","format":"int32"}}},"CallableTime":{"type":"object","properties":{"timeSlots":{"type":"array","items":{"$ref":"#/definitions/TimeSlot"}},"timeZoneId":{"type":"string"}}},"ImportStatus":{"type":"object","properties":{"state":{"type":"string","enum":["IN_PROGRESS","FAILED"]},"totalRecords":{"type":"integer","format":"int64"},"completedRecords":{"type":"integer","format":"int64"},"percentComplete":{"type":"integer","format":"int32"},"failureReason":{"type":"string"}}},"QueueEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PaymentMethod":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","enum":["CARD_TOKEN"]},"providerName":{"type":"string"},"token":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AddressListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Address"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FacetItem":{"type":"object","properties":{"name":{"type":"string"},"filterValue":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"LinkedEntityListingWorkItemSearchDetails":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/WorkItemSearchDetails"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UploadProgress":{"type":"object","properties":{"CarrierId":{"type":"string","description":"Carrier id associated with the ratesheet that was uploaded.","readOnly":true},"SchemaName":{"type":"string","description":"Human readable name for the schema that was used to parse the ratesheet.","readOnly":true},"Status":{"type":"string","description":"Human readable status for progress of the ratesheet upload. This may be an error, the number of rates upload, or a completion message.","readOnly":true},"Filename":{"type":"string","description":"Filename of the ratesheet that was uploaded by the user.","readOnly":true},"Filetype":{"type":"string","description":"Media type of the file.","readOnly":true},"Created":{"type":"string","format":"date-time","description":"Time at which the uploaded ratesheet was started to be parsed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"Updated":{"type":"string","format":"date-time","description":"Time at which the progress of the upload was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true}}},"CarrierEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Carrier"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ServiceLevel":{"type":"object","properties":{"percentage":{"type":"number","format":"double"},"durationMs":{"type":"integer","format":"int64"}}},"ConsultTransferUpdate":{"type":"object","required":["speakTo"],"properties":{"speakTo":{"type":"string","description":"Determines to whom the initiating participant is speaking.","enum":["DESTINATION","OBJECT","BOTH"]}}},"User":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"displayName":{"type":"string"},"phoneNumber":{"type":"string"},"userImages":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"chat":{"$ref":"#/definitions/Chat"},"roles":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationRole"}},"voicemailEnabled":{"type":"boolean","default":false},"department":{"type":"string"},"title":{"type":"string"},"routingStatus":{"$ref":"#/definitions/RoutingStatus"},"password":{"type":"string"},"primaryPresence":{"$ref":"#/definitions/UserPresence"},"conversations":{"$ref":"#/definitions/UserConversationSummary"},"conversationSummary":{"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"$ref":"#/definitions/OutOfOffice"},"geolocation":{"$ref":"#/definitions/Geolocation"},"permissions":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"requestedStatus":{"$ref":"#/definitions/UserStatus"},"defaultStationUri":{"type":"string","format":"uri"},"stationUri":{"type":"string","format":"uri"},"lastStationUri":{"type":"string","format":"uri","readOnly":true}}},"FacetEntry":{"type":"object","properties":{"attribute":{"$ref":"#/definitions/TermAttribute"},"statistics":{"$ref":"#/definitions/FacetStatistics"},"other":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"},"missing":{"type":"integer","format":"int64"},"termCount":{"type":"integer","format":"int32"},"termType":{"type":"string","enum":["TERM","NUMBERRANGE","NUMBERHISTOGRAM","DATERANGE","DATEHISTOGRAM","ID"]},"terms":{"type":"array","items":{"$ref":"#/definitions/FacetTerm"}}}},"PhoneBaseEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/PhoneBase"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FacetRequest":{"type":"object","required":["facetRequestQueryType","fieldName","name"],"properties":{"name":{"type":"string","description":"name of the facet request that will be returned with the result set"},"facetRequestQueryType":{"type":"string","description":"Which facet request type","enum":["TERM","RANGE"]},"fieldName":{"type":"string","description":"The fieldName to perform the facet request on."},"type":{"type":"string","description":"the fieldtype of the field to perform the facet request on.","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST","GROUP"]},"rangeFrom":{"type":"string","description":"For RANGE requests populate this field to specify the beginning of a limit (leave blank for openended).  Note this value is inclusive of the results.  (EG if the value is 1, 1 will be included in the range.)"},"rangeTo":{"type":"string","description":"For RANGE requests populate this field to specify the end of a limit (leave blank for openended).  Note this value is EXCLUSIVE of the result (EG if this value was 5, only values LESS THAN 5 will be included in the count.)"},"maxFacetCount":{"type":"integer","format":"int32","description":"Limits/expands the number of facet entries returned (default 500)"}},"description":"Used as part of a searchRequest or reportRequest to denote which facets to generate from the search results.  For RANGE facets, one of rangeFrom or rangeTo (or both) MUST be set"},"HealthCheckInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"Build-Time":{"type":"string"},"Build-Version":{"type":"string"},"Build-Jdk":{"type":"string"},"Built-By":{"type":"string"},"Implementation-Build":{"type":"string"},"Implementation-Version":{"type":"string"},"Status":{"type":"string","enum":["OK","CREATED","ACCEPTED","NO_CONTENT","RESET_CONTENT","PARTIAL_CONTENT","MOVED_PERMANENTLY","FOUND","SEE_OTHER","NOT_MODIFIED","USE_PROXY","TEMPORARY_REDIRECT","BAD_REQUEST","UNAUTHORIZED","PAYMENT_REQUIRED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","NOT_ACCEPTABLE","PROXY_AUTHENTICATION_REQUIRED","REQUEST_TIMEOUT","CONFLICT","GONE","LENGTH_REQUIRED","PRECONDITION_FAILED","REQUEST_ENTITY_TOO_LARGE","REQUEST_URI_TOO_LONG","UNSUPPORTED_MEDIA_TYPE","REQUESTED_RANGE_NOT_SATISFIABLE","EXPECTATION_FAILED","INTERNAL_SERVER_ERROR","NOT_IMPLEMENTED","BAD_GATEWAY","SERVICE_UNAVAILABLE","GATEWAY_TIMEOUT","HTTP_VERSION_NOT_SUPPORTED"]},"Ping-Ms":{"type":"integer","format":"int32"},"Date":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"CampaignStats":{"type":"object","properties":{"contactRate":{"$ref":"#/definitions/ConnectRate"},"idleAgents":{"type":"integer","format":"int32"},"adjustedCallsPerAgent":{"type":"number","format":"double"},"outstandingCalls":{"type":"integer","format":"int32"}}},"Segment":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"endTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"type":{"type":"string"},"howEnded":{"type":"string"},"disconnectType":{"type":"string"}}},"WorkItemCommandGroup":{"type":"object","properties":{"category":{"type":"string"},"defaultCommandId":{"type":"string"},"commands":{"type":"array","items":{"$ref":"#/definitions/WorkItemCommand"}}}},"ChatMessageUser":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"displayName":{"type":"string"},"username":{"type":"string"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}}}},"DomainEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DomainEntity"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SchemaCategory":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DigitLength":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}}},"TagValue":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"inUse":{"type":"boolean","default":false},"acl":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainPermission":{"type":"object","properties":{"domain":{"type":"string"},"entityType":{"type":"string"},"action":{"type":"string"},"label":{"type":"string"},"licenses":{"type":"array","items":{"type":"string"}},"allowsConditions":{"type":"boolean","default":false}}},"CreateShareResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"sharedEntityType":{"type":"string","enum":["DOCUMENT"]},"sharedEntity":{"$ref":"#/definitions/UriReference"},"memberType":{"type":"string","enum":["USER","PUBLIC"]},"member":{"$ref":"#/definitions/UriReference"},"sharedBy":{"$ref":"#/definitions/UriReference"},"workspace":{"$ref":"#/definitions/UriReference"},"succeeded":{"type":"array","items":{"$ref":"#/definitions/Share"}},"failed":{"type":"array","items":{"$ref":"#/definitions/Share"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/User"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowVersionEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/FlowVersion"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RunNowResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Preview":{"type":"object","properties":{"id":{"type":"string"},"selfUri":{"type":"string"},"campaign":{"$ref":"#/definitions/Campaign"},"contactList":{"$ref":"#/definitions/ContactList"},"contact":{"$ref":"#/definitions/Contact"},"availablePhoneNumbers":{"type":"array","items":{"type":"string"}},"remainingSeconds":{"type":"integer","format":"int32"},"scriptId":{"type":"string"},"timedOut":{"type":"boolean","default":false}}},"Service":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"status":{"type":"string"},"domains":{"type":"array","description":"An inbound carrier specific domain (i.e. lb.domain.com)","items":{"type":"string"}},"serviceTypes":{"type":"array","items":{"$ref":"#/definitions/ServiceType"}},"gateways":{"type":"array","items":{"$ref":"#/definitions/Gateway"}},"dns":{"$ref":"#/definitions/Dns"},"vpn":{"$ref":"#/definitions/Vpn"},"carrier":{"$ref":"#/definitions/Carrier"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Change":{"type":"object","properties":{"entity":{"$ref":"#/definitions/Entity"},"property":{"type":"string"},"oldValues":{"type":"array","items":{"type":"string"}},"newValues":{"type":"array","items":{"type":"string"}}}},"Contact":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"contactListId":{"type":"string"},"data":{"type":"object","additionalProperties":{"type":"object"}},"callRecords":{"type":"object","additionalProperties":{"$ref":"#/definitions/CallRecord"}},"callable":{"type":"boolean","default":false},"phoneNumberStatus":{"type":"object","additionalProperties":{"$ref":"#/definitions/PhoneNumberStatus"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Response":{"type":"object","properties":{"messageReturned":{"type":"array","items":{"type":"string"}},"status":{"type":"string"}}},"CallableTimeSetEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/CallableTimeSet"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OrphanRecording":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"createdTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"recoveredTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"providerType":{"type":"string","enum":["EDGE","CHAT","EMAIL"]},"mediaSizeBytes":{"type":"integer","format":"int64"},"mediaType":{"type":"string","enum":["CALL","CHAT","EMAIL"]},"fileState":{"type":"string","enum":["ARCHIVED","AVAILABLE","DELETED","RESTORED","RESTORING","UPLOADING"]},"providerEndpoint":{"$ref":"#/definitions/Endpoint"},"recording":{"$ref":"#/definitions/Recording"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PureCloud":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhoneEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Phone"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DialerCall":{"type":"object","properties":{"callId":{"type":"string"},"conversationId":{"type":"string"}}},"MediaPolicy":{"type":"object","properties":{"evaluationCriteria":{"type":"array","description":"When conditions are evaluation and actions applied","items":{"type":"string","enum":["CONVERSATION_COMPLETE","PER_CONVERSATION_EVENT"]}},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/PolicyConditions"},"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"}}},"Session":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"minutesToLive":{"type":"integer","format":"int64"},"userAgent":{"type":"string"},"createdOn":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"user":{"$ref":"#/definitions/User"},"language":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}}},"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"externalDocs":{"description":"PureCloud API Documentation","url":"https://developer.mypurecloud.com"}}
+{"swagger":"2.0","info":{"description":"PureCloud API","version":"v1","title":"PureCloud API","termsOfService":"http://www.inin.com","contact":{"name":"Chuck Pulfer","url":"http://www.inin.com","email":"[e-mail]"},"license":{"name":"ININ","url":"http://www.inin.com"}},"host":"api.mypurecloud.com","tags":[{"name":"Architect","description":"Prompts, IVR, schedules, voice xml, dependency tracking.","externalDocs":{"description":"architect docs","url":"https://developer.mypurecloud.com/architect"}},{"name":"Attributes","description":"Attribute definitions"},{"name":"Authorization","description":"Roles and permissions","externalDocs":{"description":"authorization docs","url":"https://developer.mypurecloud.com/authorization"}},{"name":"Compliance","description":""},{"name":"Configuration","description":""},{"name":"Content Management","description":""},{"name":"Conversations","description":""},{"name":"Docs","description":"Swagger documentation definitions","externalDocs":{"description":"docs","url":"https://developer.mypurecloud.com"}},{"name":"Downloads","description":"Download file"},{"name":"Evaluations","description":""},{"name":"External Contacts","description":"External Organizations, contacts, notes and relationships"},{"name":"Fax","description":""},{"name":"Geolocation","description":""},{"name":"Greetings","description":""},{"name":"Groups","description":"Groups, members"},{"name":"Languages","description":"Available languages"},{"name":"Licensing","description":""},{"name":"Locations","description":"Physical locations"},{"name":"Notifications","description":"Channels, subscriptions, topics"},{"name":"OAuth","description":"OAuth clients, providers"},{"name":"Outbound","description":""},{"name":"Presence","description":"User and organization presences"},{"name":"Quality","description":"Evaluations, calibrations"},{"name":"Recording","description":"Recordings, policies, annotations, orphans"},{"name":"Response Management","description":"Responses, library, query"},{"name":"Routing","description":"Queues, wrapup codes, skills, email config"},{"name":"Scripts","description":"Composer"},{"name":"Search","description":"Chat search"},{"name":"Stations","description":"Stations"},{"name":"Telephony Providers Edge","description":"Edge phones, trunks, lines.","externalDocs":{"description":"telephony provider edge","url":"https://developer.mypurecloud.com/telephonyprovideredge"}},{"name":"Tokens","description":"Authentication Tokens"},{"name":"User Recordings","description":"Summary, media"},{"name":"Users","description":"Me, routing, roles"},{"name":"Utilities","description":""},{"name":"Voicemail","description":"Mailbox, messages, policy"}],"schemes":["https"],"consumes":["application/json"],"produces":["application/json"],"paths":{"/api/v1/architect/audits":{"post":{"tags":["Architect"],"summary":"Gets architect-data-service audit entries.","description":"","operationId":"postAudits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"AuditSearchRequest","required":false,"schema":{"$ref":"#/definitions/CommonAuditRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditSearchResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postAudits"}},"/api/v1/architect/ivrs":{"get":{"tags":["Architect"],"summary":"Get IVR configs.","description":"","operationId":"getIvrs","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVREntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getIvrs"},"post":{"tags":["Architect"],"summary":"Create IVR config.","description":"","operationId":"postIvrs","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/IVR"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVR"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postIvrs"}},"/api/v1/architect/ivrs/actions/publish":{"post":{"tags":["Architect"],"summary":"Publish an IVR config.","description":"","operationId":"postIvrsActionsPublish","produces":["application/json"],"parameters":[{"name":"id","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVR"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postIvrsActionsPublish"}},"/api/v1/architect/ivrs/{ivrId}":{"get":{"tags":["Architect"],"summary":"Get an IVR config.","description":"","operationId":"getIvrsIvrId","produces":["application/json"],"parameters":[{"name":"ivrId","in":"path","description":"IVR id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVR"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getIvrsIvrId"},"put":{"tags":["Architect"],"summary":"Update an IVR Config.","description":"","operationId":"putIvrsIvrId","produces":["application/json"],"parameters":[{"name":"ivrId","in":"path","description":"IVR id","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/IVR"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVR"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putIvrsIvrId"},"delete":{"tags":["Architect"],"summary":"Delete an IVR Config.","description":"","operationId":"deleteIvrsIvrId","produces":["application/json"],"parameters":[{"name":"ivrId","in":"path","description":"IVR id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteIvrsIvrId"}},"/api/v1/architect/prompts":{"get":{"tags":["Architect"],"summary":"Get a pageable list of user prompts","description":"The returned list is pageable, and query parameters can be used for filtering.  Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated.","operationId":"getPrompts","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPrompts"},"post":{"tags":["Architect"],"summary":"Create a new user prompt","description":"","operationId":"postPrompts","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Prompt"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Prompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postPrompts"},"delete":{"tags":["Architect"],"summary":"Batch-delete a list of prompts","description":"Multiple IDs can be specified, in which case all specified prompts will be deleted.","operationId":"deletePrompts","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"List of Prompt IDs","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"ignoreDependencies","in":"query","description":"Ignore Dependencies","required":false,"type":"boolean","default":false}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deletePrompts"}},"/api/v1/architect/prompts/{promptId}":{"get":{"tags":["Architect"],"summary":"Get specified user prompt","description":"","operationId":"getPromptsPromptId","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Prompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPromptsPromptId"},"put":{"tags":["Architect"],"summary":"Update specified user prompt","description":"","operationId":"putPromptsPromptId","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Prompt"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Prompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putPromptsPromptId"},"delete":{"tags":["Architect"],"summary":"Delete specified user prompt","description":"","operationId":"deletePromptsPromptId","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deletePromptsPromptId"}},"/api/v1/architect/prompts/{promptId}/resources":{"get":{"tags":["Architect"],"summary":"Get a pageable list of user prompt resources","description":"The returned list is pageable, and query paramaters can be used for filtering.","operationId":"getPromptsPromptIdResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAssetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPromptsPromptIdResources"},"post":{"tags":["Architect"],"summary":"Create a new user prompt resource.","description":"","operationId":"postPromptsPromptIdResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PromptAsset"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postPromptsPromptIdResources"}},"/api/v1/architect/prompts/{promptId}/resources/{language}":{"get":{"tags":["Architect"],"summary":"Get specified user prompt resource","description":"","operationId":"getPromptsPromptIdResourcesLanguage","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"language","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPromptsPromptIdResourcesLanguage"},"put":{"tags":["Architect"],"summary":"Update specified user prompt resource","description":"","operationId":"putPromptsPromptIdResourcesLanguage","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"language","in":"path","description":"Language","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PromptAsset"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putPromptsPromptIdResourcesLanguage"},"delete":{"tags":["Architect"],"summary":"Delete specified user prompt resource","description":"","operationId":"deletePromptsPromptIdResourcesLanguage","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"language","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deletePromptsPromptIdResourcesLanguage"}},"/api/v1/architect/schedulegroups":{"get":{"tags":["Architect"],"summary":"Get a list of schedule groups.","description":"","operationId":"getSchedulegroups","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchedulegroups"},"post":{"tags":["Architect"],"summary":"Creates a new schedule group","description":"","operationId":"postSchedulegroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ScheduleGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSchedulegroups"}},"/api/v1/architect/schedulegroups/{scheduleGroupId}":{"get":{"tags":["Architect"],"summary":"Gets a schedule group by ID","description":"","operationId":"getSchedulegroupsSchedulegroupId","produces":["application/json"],"parameters":[{"name":"scheduleGroupId","in":"path","description":"Schedule group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchedulegroupsSchedulegroupId"},"put":{"tags":["Architect"],"summary":"Updates a schedule group by ID","description":"","operationId":"putSchedulegroupsSchedulegroupId","produces":["application/json"],"parameters":[{"name":"scheduleGroupId","in":"path","description":"Schedule group ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ScheduleGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSchedulegroupsSchedulegroupId"},"delete":{"tags":["Architect"],"summary":"Deletes a schedule group by ID","description":"","operationId":"deleteSchedulegroupsSchedulegroupId","produces":["application/json"],"parameters":[{"name":"scheduleGroupId","in":"path","description":"Schedule group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSchedulegroupsSchedulegroupId"}},"/api/v1/architect/schedules":{"get":{"tags":["Architect"],"summary":"Get a list of schedules.","description":"","operationId":"getSchedules","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchedules"},"post":{"tags":["Architect"],"summary":"Create a new schedule.","description":"","operationId":"postSchedules","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Schedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Schedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSchedules"}},"/api/v1/architect/schedules/{scheduleId}":{"get":{"tags":["Architect"],"summary":"Get a schedule by ID","description":"","operationId":"getSchedulesScheduleId","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Schedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchedulesScheduleId"},"put":{"tags":["Architect"],"summary":"Update schedule by ID","description":"","operationId":"putSchedulesScheduleId","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Schedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Schedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSchedulesScheduleId"},"delete":{"tags":["Architect"],"summary":"Delete a schedule by id","description":"","operationId":"deleteSchedulesScheduleId","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSchedulesScheduleId"}},"/api/v1/architect/systemprompts":{"get":{"tags":["Architect"],"summary":"Get System Prompts.","description":"","operationId":"getSystemprompts","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSystemprompts"}},"/api/v1/architect/systemprompts/{promptId}":{"get":{"tags":["Architect"],"summary":"Get IVR system prompt.","description":"","operationId":"getSystempromptsPromptId","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPrompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSystempromptsPromptId"}},"/api/v1/architect/systemprompts/{promptId}/resources":{"get":{"tags":["Architect"],"summary":"Get IVR System Prompt resources.","description":"","operationId":"getSystempromptsPromptIdResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAssetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSystempromptsPromptIdResources"},"post":{"tags":["Architect"],"summary":"Create system prompt resource override.","description":"","operationId":"postSystempromptsPromptIdResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SystemPromptAsset"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSystempromptsPromptIdResources"}},"/api/v1/architect/systemprompts/{promptId}/resources/{language}":{"get":{"tags":["Architect"],"summary":"Get a system prompt resource.","description":"","operationId":"getSystempromptsPromptIdResourcesLanguage","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"language","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSystempromptsPromptIdResourcesLanguage"},"delete":{"tags":["Architect"],"summary":"Delete a system prompt resource override.","description":"","operationId":"deleteSystempromptsPromptIdResourcesLanguage","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"language","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSystempromptsPromptIdResourcesLanguage"}},"/api/v1/attributes":{"get":{"tags":["Attributes"],"summary":"Gets a list of existing attributes.","description":"","operationId":"getAttributes","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttributeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getAttributes"},"post":{"tags":["Attributes"],"summary":"Create an attribute.","description":"","operationId":"postAttributes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Attribute","required":false,"schema":{"$ref":"#/definitions/Attribute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Attribute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postAttributes"}},"/api/v1/attributes/query":{"post":{"tags":["Attributes"],"summary":"Query attributes","description":"","operationId":"postQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":false,"schema":{"$ref":"#/definitions/AttributeQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttributeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQuery"}},"/api/v1/attributes/{attributeId}":{"get":{"tags":["Attributes"],"summary":"Get details about an existing attribute.","description":"","operationId":"getAttributeId","produces":["application/json"],"parameters":[{"name":"attributeId","in":"path","description":"Attribute ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Attribute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getAttributeId"},"put":{"tags":["Attributes"],"summary":"Update an existing attribute.","description":"Fields that can be updated: name, description. The most recent version is required for updates.","operationId":"putAttributeId","produces":["application/json"],"parameters":[{"name":"attributeId","in":"path","description":"Attribute ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Attribute","required":false,"schema":{"$ref":"#/definitions/Attribute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Attribute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"409":{"description":"Resource conflict - Unexpected version was provided"},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putAttributeId"},"delete":{"tags":["Attributes"],"summary":"Delete an existing Attribute.","description":"This will remove attribute.","operationId":"deleteAttributeId","produces":["application/json"],"parameters":[{"name":"attributeId","in":"path","description":"Attribute ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteAttributeId"}},"/api/v1/authorization/licenses":{"get":{"tags":["Authorization"],"summary":"Retrieve a list of all licenses defined in the system","description":"","operationId":"getLicenses","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLicenseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLicenses"}},"/api/v1/authorization/permissions":{"get":{"tags":["Authorization"],"summary":"Get all permissions.","description":"Retrieve a list of all permission defined in the system.","operationId":"getPermissions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PermissionCollectionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPermissions"}},"/api/v1/authorization/products":{"get":{"tags":["Authorization"],"summary":"Get the list of enabled products","description":"Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.","operationId":"getProducts","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationProductEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProducts"}},"/api/v1/authorization/roles":{"get":{"tags":["Authorization"],"summary":"Retrieve a list of all roles defined for the organization","description":"","operationId":"getRoles","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"permission","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"userCount","in":"query","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRoles"},"post":{"tags":["Authorization"],"summary":"Create an organization role.","description":"","operationId":"postRoles","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DomainOrganizationRole"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRoles"}},"/api/v1/authorization/roles/default":{"post":{"tags":["Authorization"],"summary":"Restores all default roles","description":"This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles.","operationId":"postRolesDefault","produces":["application/json"],"parameters":[{"name":"force","in":"query","description":"Restore default roles","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRolesDefault"},"put":{"tags":["Authorization"],"summary":"Restore specified default roles","description":"","operationId":"putRolesDefault","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationRole"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRolesDefault"}},"/api/v1/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}":{"get":{"tags":["Authorization"],"summary":"Get an org role to default role comparison comparison","description":"Compares any organization role to a default role id and show differences","operationId":"getRolesLeftroleIdComparedefaultRightroleId","produces":["application/json"],"parameters":[{"name":"leftRoleId","in":"path","description":"Left Role ID","required":true,"type":"string"},{"name":"rightRoleId","in":"path","description":"Right Role id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrgRoleDifference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRolesLeftroleIdComparedefaultRightroleId"},"post":{"tags":["Authorization"],"summary":" Get an unsaved org role to default role comparison","description":"Allows users to compare their existing roles in an unsaved state to its default role","operationId":"postRolesLeftroleIdComparedefaultRightroleId","produces":["application/json"],"parameters":[{"name":"leftRoleId","in":"path","description":"Left Role ID","required":true,"type":"string"},{"name":"rightRoleId","in":"path","description":"Right Role id","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DomainOrganizationRole"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrgRoleDifference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRolesLeftroleIdComparedefaultRightroleId"}},"/api/v1/authorization/roles/{roleId}":{"get":{"tags":["Authorization"],"summary":"Get a single organization role.","description":"Get the organization role specified by its ID.","operationId":"getRolesRoleId","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRolesRoleId"},"put":{"tags":["Authorization"],"summary":"Update an organization role.","description":"Update","operationId":"putRolesRoleId","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DomainOrganizationRole"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRolesRoleId"},"delete":{"tags":["Authorization"],"summary":"Delete an organization role.","description":"","operationId":"deleteRolesRoleId","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteRolesRoleId"},"patch":{"tags":["Authorization"],"summary":"Patch Organization Role for needsUpdate Field","description":"Patch Organization Role for needsUpdate Field","operationId":"patchRolesRoleId","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DomainOrganizationRole"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchRolesRoleId"}},"/api/v1/authorization/roles/{roleId}/users/add":{"put":{"tags":["Authorization"],"summary":"Sets the users for the role","description":"","operationId":"putRolesRoleIdUsersAdd","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRolesRoleIdUsersAdd"}},"/api/v1/authorization/roles/{roleId}/users/remove":{"put":{"tags":["Authorization"],"summary":"Removes the users from the role","description":"","operationId":"putRolesRoleIdUsersRemove","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRolesRoleIdUsersRemove"}},"/api/v1/authorization/users/{userId}/roles":{"get":{"tags":["Authorization"],"summary":"Get the list of roles for a user.","description":"","operationId":"getUsersUserIdRoles","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUsersUserIdRoles"},"put":{"tags":["Authorization"],"summary":"Sets the user's roles","description":"","operationId":"putUsersUserIdRoles","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUsersUserIdRoles"},"delete":{"tags":["Authorization"],"summary":"Removes all the roles from the user.","description":"","operationId":"deleteUsersUserIdRoles","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteUsersUserIdRoles"}},"/api/v1/certificate/details":{"post":{"tags":["Utilities"],"summary":"Returns the information about an X509 PEM encoded certificate or certificate chain.","description":"","operationId":"postDetails","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Certificate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ParsedCertificate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDetails"}},"/api/v1/compliance/hipaa":{"get":{"tags":["Compliance"],"summary":"Get information about HIPAA compliance","description":"","operationId":"getHipaa","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HIPAAConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getHipaa"},"put":{"tags":["Compliance"],"summary":"Update HIPAA compliance options","description":"","operationId":"putHipaa","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/HIPAAConfig"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HIPAAConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putHipaa"}},"/api/v1/configuration/addressvalidation":{"post":{"tags":["Utilities"],"summary":"Validates a street address","description":"","operationId":"postAddressvalidation","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ValidateAddressRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ValidateAddressResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postAddressvalidation"}},"/api/v1/configuration/didpools":{"get":{"tags":["Configuration"],"summary":"Get a listing of DID Pools","description":"","operationId":"getDidpools","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPoolEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDidpools"},"post":{"tags":["Configuration"],"summary":"Create a new DID pool","description":"","operationId":"postDidpools","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DIDPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDidpools"}},"/api/v1/configuration/didpools/{didPoolId}":{"get":{"tags":["Configuration"],"summary":"Get a DID Pool by ID.","description":"","operationId":"getDidpoolsDidpoolId","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDidpoolsDidpoolId"},"put":{"tags":["Configuration"],"summary":"Update a DID Pool by ID.","description":"","operationId":"putDidpoolsDidpoolId","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DIDPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putDidpoolsDidpoolId"},"delete":{"tags":["Configuration"],"summary":"Delete a DID Pool by ID.","description":"","operationId":"deleteDidpoolsDidpoolId","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteDidpoolsDidpoolId"}},"/api/v1/configuration/dids":{"get":{"tags":["Configuration"],"summary":"Get a listing of DIDs","description":"","operationId":"getDids","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"phoneNumber","in":"query","description":"Filter by phoneNumber","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDids"}},"/api/v1/configuration/dids/{didId}":{"get":{"tags":["Configuration"],"summary":"Get a DID by ID.","description":"","operationId":"getDidsDidId","produces":["application/json"],"parameters":[{"name":"didId","in":"path","description":"DID ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DID"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDidsDidId"},"put":{"tags":["Configuration"],"summary":"Update a DID by ID.","description":"","operationId":"putDidsDidId","produces":["application/json"],"parameters":[{"name":"didId","in":"path","description":"DID ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DID"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DID"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putDidsDidId"}},"/api/v1/configuration/edges":{"get":{"tags":["Configuration"],"summary":"Get the list of edges.","description":"","operationId":"getEdges","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"site.id","in":"query","description":"Filter by site.id","required":false,"type":"string"},{"name":"edgeGroup.id","in":"query","description":"Filter by edgeGroup.id","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdges"},"post":{"tags":["Configuration"],"summary":"Create a edge.","description":"","operationId":"postEdges","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Edge","required":false,"schema":{"$ref":"#/definitions/Edge"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEdges"}},"/api/v1/configuration/edges/certificateauthorities":{"get":{"tags":["Configuration"],"summary":"Get the list of certificate authorities.","description":"","operationId":"getEdgesCertificateauthorities","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CertificateAuthorityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesCertificateauthorities"},"post":{"tags":["Configuration"],"summary":"Create a certificate authority.","description":"","operationId":"postEdgesCertificateauthorities","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CertificateAuthority","required":false,"schema":{"$ref":"#/definitions/DomainCertificateAuthority"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEdgesCertificateauthorities"}},"/api/v1/configuration/edges/certificateauthorities/{certificateId}":{"get":{"tags":["Configuration"],"summary":"Get a certificate authority.","description":"","operationId":"getEdgesCertificateauthoritiesCertificateId","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesCertificateauthoritiesCertificateId"},"put":{"tags":["Configuration"],"summary":"Update a certificate authority.","description":"","operationId":"putEdgesCertificateauthoritiesCertificateId","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DomainCertificateAuthority"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putEdgesCertificateauthoritiesCertificateId"},"delete":{"tags":["Configuration"],"summary":"Delete a certificate authority.","description":"","operationId":"deleteEdgesCertificateauthoritiesCertificateId","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteEdgesCertificateauthoritiesCertificateId"}},"/api/v1/configuration/edges/{edgeId}":{"get":{"tags":["Configuration"],"summary":"Get edge.","description":"","operationId":"getEdgesEdgeId","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesEdgeId"},"put":{"tags":["Configuration"],"summary":"Update a edge.","description":"","operationId":"putEdgesEdgeId","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Edge","required":false,"schema":{"$ref":"#/definitions/Edge"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putEdgesEdgeId"},"delete":{"tags":["Configuration"],"summary":"Delete a edge.","description":"","operationId":"deleteEdgesEdgeId","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteEdgesEdgeId"}},"/api/v1/configuration/edges/{edgeId}/lines":{"get":{"tags":["Configuration"],"summary":"Get the list of lines.","description":"","operationId":"getEdgesEdgeIdLines","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeLineEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesEdgeIdLines"}},"/api/v1/configuration/edges/{edgeId}/lines/{lineId}":{"get":{"tags":["Configuration"],"summary":"Get line","description":"","operationId":"getEdgesEdgeIdLinesLineId","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"lineId","in":"path","description":"Line ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeLine"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesEdgeIdLinesLineId"},"put":{"tags":["Configuration"],"summary":"Update a line.","description":"","operationId":"putEdgesEdgeIdLinesLineId","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"lineId","in":"path","description":"Line ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Line","required":false,"schema":{"$ref":"#/definitions/EdgeLine"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeLine"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putEdgesEdgeIdLinesLineId"}},"/api/v1/configuration/edges/{edgeId}/logicalinterfaces":{"get":{"tags":["Configuration"],"summary":"Get edge logical interfaces.","description":"Retrieve a list of all configured logical interfaces from a specific edge.","operationId":"getEdgesEdgeIdLogicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesEdgeIdLogicalinterfaces"},"post":{"tags":["Configuration"],"summary":"Create an edge logical interface.","description":"Create","operationId":"postEdgesEdgeIdLogicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DomainLogicalInterface"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEdgesEdgeIdLogicalinterfaces"}},"/api/v1/configuration/edges/{edgeId}/logicalinterfaces/{interfaceId}":{"get":{"tags":["Configuration"],"summary":"Get an edge logical interface","description":"","operationId":"getEdgesEdgeIdLogicalinterfacesInterfaceId","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesEdgeIdLogicalinterfacesInterfaceId"},"put":{"tags":["Configuration"],"summary":"Update an edge logical interface.","description":"","operationId":"putEdgesEdgeIdLogicalinterfacesInterfaceId","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DomainLogicalInterface"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putEdgesEdgeIdLogicalinterfacesInterfaceId"},"delete":{"tags":["Configuration"],"summary":"Delete an edge logical interface","description":"","operationId":"deleteEdgesEdgeIdLogicalinterfacesInterfaceId","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteEdgesEdgeIdLogicalinterfacesInterfaceId"}},"/api/v1/configuration/edges/{edgeId}/logs/jobs":{"post":{"tags":["Configuration"],"summary":"Create a job to upload a list of Edge logs.","description":"","operationId":"postEdgesEdgeIdLogsJobs","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EdgeLogsJobRequest","required":false,"schema":{"$ref":"#/definitions/EdgeLogsJobRequest"}}],"responses":{"202":{"description":"Accepted - Job is being processed.  The job ID is returned.","schema":{"$ref":"#/definitions/EdgeLogsJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEdgesEdgeIdLogsJobs"}},"/api/v1/configuration/edges/{edgeId}/logs/jobs/{jobId}":{"get":{"tags":["Configuration"],"summary":"Get an Edge logs job.","description":"","operationId":"getEdgesEdgeIdLogsJobsJobId","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"}],"responses":{"200":{"description":"Edge log list has been returned in the response.","schema":{"$ref":"#/definitions/EdgeLogsJob"}},"202":{"description":"Accepted - Processing Edge logs job, try again soon."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesEdgeIdLogsJobsJobId"}},"/api/v1/configuration/edges/{edgeId}/logs/jobs/{jobId}/upload":{"post":{"tags":["Configuration"],"summary":"Request that the specified fileIds be uploaded from the Edge.","description":"","operationId":"postEdgesEdgeIdLogsJobsJobIdUpload","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/EdgeLogsJobUploadRequest"}}],"responses":{"202":{"description":"Accepted - Files are being uploaded to the job.  Watch the uploadStatus property on the job files."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEdgesEdgeIdLogsJobsJobIdUpload"}},"/api/v1/configuration/edges/{edgeId}/physicalinterfaces":{"get":{"tags":["Configuration"],"summary":"Retrieve a list of all configured physical interfaces from a specific edge.","description":"","operationId":"getEdgesEdgeIdPhysicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhysicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesEdgeIdPhysicalinterfaces"}},"/api/v1/configuration/edges/{edgeId}/physicalinterfaces/{interfaceId}":{"get":{"tags":["Configuration"],"summary":"Get edge physical interface.","description":"Retrieve a physical interface from a specific edge.","operationId":"getEdgesEdgeIdPhysicalinterfacesInterfaceId","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainPhysicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesEdgeIdPhysicalinterfacesInterfaceId"}},"/api/v1/configuration/edges/{edgeId}/reboot":{"post":{"tags":["Configuration"],"summary":"Reboot an Edge","description":"","operationId":"postEdgesEdgeIdReboot","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEdgesEdgeIdReboot"}},"/api/v1/configuration/edges/{edgeId}/softwareupdate":{"get":{"tags":["Configuration"],"summary":"Gets software update status information about any edge.","description":"","operationId":"getEdgesEdgeIdSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesEdgeIdSoftwareupdate"},"post":{"tags":["Configuration"],"summary":"Starts a software update for this edge.","description":"","operationId":"postEdgesEdgeIdSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEdgesEdgeIdSoftwareupdate"},"delete":{"tags":["Configuration"],"summary":"Cancels any in-progress update for this edge.","description":"","operationId":"deleteEdgesEdgeIdSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteEdgesEdgeIdSoftwareupdate"}},"/api/v1/configuration/edges/{edgeId}/softwareversions":{"get":{"tags":["Configuration"],"summary":"Gets all the available software versions for this edge.","description":"","operationId":"getEdgesEdgeIdSoftwareversions","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareVersionDto"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgesEdgeIdSoftwareversions"}},"/api/v1/configuration/edges/{edgeId}/unpair":{"post":{"tags":["Configuration"],"summary":"Unpair an Edge","description":"","operationId":"postEdgesEdgeIdUnpair","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEdgesEdgeIdUnpair"}},"/api/v1/configuration/edgeversionreport":{"get":{"tags":["Configuration"],"summary":"Get the edge version report.","description":"The report will not have consistent data about the edge version(s) until all edges have been reset.","operationId":"getEdgeversionreport","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeVersionReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEdgeversionreport"}},"/api/v1/configuration/endpoints":{"get":{"tags":["Configuration"],"summary":"Get endpoints","description":"","operationId":"getEndpoints","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EndpointEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEndpoints"},"post":{"tags":["Configuration"],"summary":"Create endpoint","description":"","operationId":"postEndpoints","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"EndpointTemplate","required":false,"schema":{"$ref":"#/definitions/Endpoint"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Endpoint"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEndpoints"}},"/api/v1/configuration/endpoints/{endpointId}":{"get":{"tags":["Configuration"],"summary":"Get endpoint","description":"","operationId":"getEndpointsEndpointId","produces":["application/json"],"parameters":[{"name":"endpointId","in":"path","description":"Endpoint ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Endpoint"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEndpointsEndpointId"},"put":{"tags":["Configuration"],"summary":"Update endpoint","description":"","operationId":"putEndpointsEndpointId","produces":["application/json"],"parameters":[{"name":"endpointId","in":"path","description":"Endpoint ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EndpointTemplate","required":false,"schema":{"$ref":"#/definitions/Endpoint"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Endpoint"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putEndpointsEndpointId"},"delete":{"tags":["Configuration"],"summary":"Delete endpoint","description":"","operationId":"deleteEndpointsEndpointId","produces":["application/json"],"parameters":[{"name":"endpointId","in":"path","description":"Endpoint ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteEndpointsEndpointId"}},"/api/v1/configuration/extensionpools":{"get":{"tags":["Configuration"],"summary":"Get a listing of extension pools","description":"","operationId":"getExtensionpools","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"startNumber"},{"name":"number","in":"query","description":"Number","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPoolEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getExtensionpools"},"post":{"tags":["Configuration"],"summary":"Create a new extension pool","description":"","operationId":"postExtensionpools","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExtensionPool","required":false,"schema":{"$ref":"#/definitions/ExtensionPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Extension"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postExtensionpools"}},"/api/v1/configuration/extensionpools/{extensionPoolId}":{"get":{"tags":["Configuration"],"summary":"Get an extension pool by ID","description":"","operationId":"getExtensionpoolsExtensionpoolId","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getExtensionpoolsExtensionpoolId"},"put":{"tags":["Configuration"],"summary":"Update an extension pool by ID","description":"","operationId":"putExtensionpoolsExtensionpoolId","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExtensionPool","required":false,"schema":{"$ref":"#/definitions/ExtensionPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putExtensionpoolsExtensionpoolId"},"delete":{"tags":["Configuration"],"summary":"Delete an extension pool by ID","description":"","operationId":"deleteExtensionpoolsExtensionpoolId","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteExtensionpoolsExtensionpoolId"}},"/api/v1/configuration/extensions":{"get":{"tags":["Configuration"],"summary":"Get a listing of extensions","description":"","operationId":"getExtensions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"number","in":"query","description":"Filter by number","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getExtensions"}},"/api/v1/configuration/extensions/{extensionId}":{"get":{"tags":["Configuration"],"summary":"Get an extension by ID.","description":"","operationId":"getExtensionsExtensionId","produces":["application/json"],"parameters":[{"name":"extensionId","in":"path","description":"Extension ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Extension"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getExtensionsExtensionId"},"put":{"tags":["Configuration"],"summary":"Update an extension by ID.","description":"","operationId":"putExtensionsExtensionId","produces":["application/json"],"parameters":[{"name":"extensionId","in":"path","description":"Extension ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Extension"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Extension"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putExtensionsExtensionId"}},"/api/v1/configuration/organization":{"get":{"tags":["Configuration"],"summary":"Get context organization.","description":"","operationId":"getOrganization","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrganization"},"put":{"tags":["Configuration"],"summary":"Update context organization.","description":"","operationId":"putOrganization","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization","required":false,"schema":{"$ref":"#/definitions/Organization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putOrganization"}},"/api/v1/configuration/organizations":{"post":{"tags":["Configuration"],"summary":"Create organization.","description":"","operationId":"postOrganizations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization","required":false,"schema":{"$ref":"#/definitions/OrganizationCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postOrganizations"}},"/api/v1/configuration/organizations/{orgId}":{"get":{"tags":["Configuration"],"summary":"Get organization.","description":"","operationId":"getOrganizationsOrgId","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","description":"Organization ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrganizationsOrgId"},"put":{"tags":["Configuration"],"summary":"Update organization.","description":"","operationId":"putOrganizationsOrgId","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","description":"Organization ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization","required":false,"schema":{"$ref":"#/definitions/Organization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putOrganizationsOrgId"},"delete":{"tags":["Configuration"],"summary":"Delete an organization.","description":"","operationId":"deleteOrganizationsOrgId","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","description":"Organization ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteOrganizationsOrgId"}},"/api/v1/configuration/recordingkeys":{"get":{"tags":["Configuration"],"summary":"Get encryption key list","description":"","operationId":"getRecordingkeys","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EncryptionKeyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRecordingkeys"},"post":{"tags":["Configuration"],"summary":"Create encryption key","description":"","operationId":"postRecordingkeys","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EncryptionKey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRecordingkeys"}},"/api/v1/configuration/recordingkeys/rotationschedule":{"get":{"tags":["Configuration"],"summary":"Get key rotation schedule","description":"","operationId":"getRecordingkeysRotationschedule","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeyRotationSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRecordingkeysRotationschedule"},"put":{"tags":["Configuration"],"summary":"Update key rotation schedule","description":"","operationId":"putRecordingkeysRotationschedule","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"KeyRotationSchedule","required":false,"schema":{"$ref":"#/definitions/KeyRotationSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeyRotationSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRecordingkeysRotationschedule"}},"/api/v1/configuration/retentionpolicies":{"get":{"tags":["Configuration"],"summary":"Gets retention policy list with query options to filter on name and enabled.","description":"for a less verbose response, add summary=true to this endpoint","operationId":"getRetentionpolicies","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"the policy name - used for filtering results in searches.","required":false,"type":"string"},{"name":"enabled","in":"query","description":"checks to see if policy is enabled - use enabled = true or enabled = false","required":false,"type":"boolean"},{"name":"summary","in":"query","description":"provides a less verbose response of policy lists.","required":false,"type":"boolean","default":false},{"name":"hasErrors","in":"query","description":"provides a way to fetch all policies with errors or policies that do not have errors","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PolicyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRetentionpolicies"},"post":{"tags":["Configuration"],"summary":"Create retention policy","description":"","operationId":"postRetentionpolicies","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Policy","required":false,"schema":{"$ref":"#/definitions/Policy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRetentionpolicies"},"delete":{"tags":["Configuration"],"summary":"Delete policies","description":"Bulk delete of Rules from specified rule set, this will only delete the rules that match the ids specified in the query param.","operationId":"deleteRetentionpolicies","produces":["application/json"],"parameters":[{"name":"ids","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteRetentionpolicies"}},"/api/v1/configuration/retentionpolicies/{policyId}":{"get":{"tags":["Configuration"],"summary":"Get policy","description":"","operationId":"getRetentionpoliciesPolicyId","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRetentionpoliciesPolicyId"},"put":{"tags":["Configuration"],"summary":"Update policy","description":"","operationId":"putRetentionpoliciesPolicyId","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":false,"schema":{"$ref":"#/definitions/Policy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRetentionpoliciesPolicyId"},"delete":{"tags":["Configuration"],"summary":"Delete policy","description":"","operationId":"deleteRetentionpoliciesPolicyId","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteRetentionpoliciesPolicyId"},"patch":{"tags":["Configuration"],"summary":"Patch a retention policy","description":"","operationId":"patchRetentionpoliciesPolicyId","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":false,"schema":{"$ref":"#/definitions/Policy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchRetentionpoliciesPolicyId"}},"/api/v1/configuration/schemas/edges/vnext":{"get":{"tags":["Configuration"],"summary":"Lists available schema categories","description":"","operationId":"getSchemasEdgesVnext","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchemaCategoryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchemasEdgesVnext"}},"/api/v1/configuration/schemas/edges/vnext/{schemaCategory}":{"get":{"tags":["Configuration"],"summary":"List schemas of a specific category","description":"","operationId":"getSchemasEdgesVnextSchemacategory","produces":["application/json"],"parameters":[{"name":"schemaCategory","in":"path","description":"Schema category","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchemaReferenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchemasEdgesVnextSchemacategory"}},"/api/v1/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}":{"get":{"tags":["Configuration"],"summary":"List schemas of a specific category","description":"","operationId":"getSchemasEdgesVnextSchemacategorySchematype","produces":["application/json"],"parameters":[{"name":"schemaCategory","in":"path","description":"Schema category","required":true,"type":"string"},{"name":"schemaType","in":"path","description":"Schema type","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchemaReferenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchemasEdgesVnextSchemacategorySchematype"}},"/api/v1/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}":{"get":{"tags":["Configuration"],"summary":"Get a json schema","description":"","operationId":"getSchemasEdgesVnextSchemacategorySchematypeSchemaId","produces":["application/json"],"parameters":[{"name":"schemaCategory","in":"path","description":"Schema category","required":true,"type":"string"},{"name":"schemaType","in":"path","description":"Schema type","required":true,"type":"string"},{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchemasEdgesVnextSchemacategorySchematypeSchemaId"}},"/api/v1/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}/{extension}/{metadataId}":{"get":{"tags":["Configuration"],"summary":"Get metadata for a schema","description":"","operationId":"getSchemasEdgesVnextSchemacategorySchematypeSchemaIdExtensionMetadataId","produces":["application/json"],"parameters":[{"name":"schemaCategory","in":"path","description":"Schema category","required":true,"type":"string"},{"name":"schemaType","in":"path","description":"Schema type","required":true,"type":"string"},{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"name":"extension","in":"path","description":"extension","required":true,"type":"string"},{"name":"metadataId","in":"path","description":"Metadata ID","required":true,"type":"string"},{"name":"type","in":"query","description":"Type","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchemasEdgesVnextSchemacategorySchematypeSchemaIdExtensionMetadataId"}},"/api/v1/configuration/sites":{"get":{"tags":["Configuration"],"summary":"Get the list of sites.","description":"","operationId":"getSites","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"location.id","in":"query","description":"Location Id","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SiteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSites"},"post":{"tags":["Configuration"],"summary":"Create a endpoint.","description":"","operationId":"postSites","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Site","required":false,"schema":{"$ref":"#/definitions/Site"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSites"}},"/api/v1/configuration/sites/{siteId}":{"get":{"tags":["Configuration"],"summary":"Get endpoint.","description":"","operationId":"getSitesSiteId","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSitesSiteId"},"put":{"tags":["Configuration"],"summary":"Update a endpoint.","description":"","operationId":"putSitesSiteId","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Site","required":false,"schema":{"$ref":"#/definitions/Site"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSitesSiteId"},"delete":{"tags":["Configuration"],"summary":"Delete an ednpoint","description":"","operationId":"deleteSitesSiteId","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSitesSiteId"}},"/api/v1/configuration/sites/{siteId}/numberplans":{"get":{"tags":["Configuration"],"summary":"Get the list of Number Plans for this Site.","description":"","operationId":"getSitesSiteIdNumberplans","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSitesSiteIdNumberplans"},"put":{"tags":["Configuration"],"summary":"Update the list of Number Plans.","description":"","operationId":"putSitesSiteIdNumberplans","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSitesSiteIdNumberplans"}},"/api/v1/configuration/sites/{siteId}/numberplans/classifications":{"get":{"tags":["Configuration"],"summary":"Get a list of Classifications for this Site","description":"","operationId":"getSitesSiteIdNumberplansClassifications","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"classification","in":"query","description":"Classification","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","uniqueItems":true,"items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSitesSiteIdNumberplansClassifications"}},"/api/v1/configuration/sites/{siteId}/numberplans/{numberPlanId}":{"get":{"tags":["Configuration"],"summary":"Get a Number Plan by ID.","description":"","operationId":"getSitesSiteIdNumberplansNumberplanId","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"numberPlanId","in":"path","description":"Number Plan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NumberPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSitesSiteIdNumberplansNumberplanId"}},"/api/v1/configuration/sites/{siteId}/rebalance":{"post":{"tags":["Configuration"],"summary":"Triggers the rebalance operation.","description":"","operationId":"postSitesSiteIdRebalance","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing the Rebalance"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSitesSiteIdRebalance"}},"/api/v1/configuration/uservoicemailpolicies/{userId}":{"get":{"tags":["Voicemail"],"summary":"Get a user's voicemail policy","description":"","operationId":"getUservoicemailpoliciesUserId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUservoicemailpoliciesUserId"},"patch":{"tags":["Voicemail"],"summary":"Update a user's voicemail policy","description":"","operationId":"patchUservoicemailpoliciesUserId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The user's voicemail policy","required":true,"schema":{"$ref":"#/definitions/VoicemailUserPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUservoicemailpoliciesUserId"}},"/api/v1/configuration/voicemailpolicy":{"get":{"tags":["Voicemail"],"summary":"Get a policy","description":"","operationId":"getVoicemailpolicy","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailOrganizationPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getVoicemailpolicy"},"put":{"tags":["Voicemail"],"summary":"Update a policy","description":"","operationId":"putVoicemailpolicy","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Policy","required":false,"schema":{"$ref":"#/definitions/VoicemailOrganizationPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailOrganizationPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putVoicemailpolicy"}},"/api/v1/contentmanagement/auditquery":{"post":{"tags":["Content Management"],"summary":"Query audits","description":"","operationId":"postAuditquery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Allows for a filtered query returning facet information","required":true,"schema":{"$ref":"#/definitions/ContentQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postAuditquery"}},"/api/v1/contentmanagement/documents":{"get":{"tags":["Content Management"],"summary":"Get a list of documents.","description":"","operationId":"getDocuments","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"query","description":"Workspace ID","required":true,"type":"string"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl","workspace"]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"name or dateCreated","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"ascending or descending","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDocuments"},"post":{"tags":["Content Management"],"summary":"Add a document.","description":"","operationId":"postDocuments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Document","required":false,"schema":{"$ref":"#/definitions/DocumentUpload"}},{"name":"copySource","in":"query","description":"Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source.","required":false,"type":"string"},{"name":"moveSource","in":"query","description":"Move a document to a new workspace. Provide a document ID as the move source.","required":false,"type":"string"},{"name":"override","in":"query","description":"Override any lock on the source document","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"423":{"description":"Locked - The source document is locked by another operation"},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDocuments"}},"/api/v1/contentmanagement/documents/{documentId}":{"get":{"tags":["Content Management"],"summary":"Get a document.","description":"","operationId":"getDocumentsDocumentId","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["lockInfo","acl","workspace"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDocumentsDocumentId"},"post":{"tags":["Content Management"],"summary":"Update a document.","description":"","operationId":"postDocumentsDocumentId","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Document","required":false,"schema":{"$ref":"#/definitions/DocumentUpdate"}},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl"]},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"409":{"description":"Resource conflict - Unexpected changeNumber was provided"},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDocumentsDocumentId"},"delete":{"tags":["Content Management"],"summary":"Delete a document.","description":"","operationId":"deleteDocumentsDocumentId","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteDocumentsDocumentId"}},"/api/v1/contentmanagement/documents/{documentId}/audits":{"get":{"tags":["Content Management"],"summary":"Get a list of audits for a document.","description":"","operationId":"getDocumentsDocumentIdAudits","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"transactionFilter","in":"query","description":"Transaction filter","required":false,"type":"string"},{"name":"level","in":"query","description":"level","required":false,"type":"string","default":"USER"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentAuditEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDocumentsDocumentIdAudits"}},"/api/v1/contentmanagement/documents/{documentId}/content":{"get":{"tags":["Content Management"],"summary":"Download a document.","description":"","operationId":"getDocumentsDocumentIdContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"disposition","in":"query","description":"Request how the content will be downloaded: attached as a file or inline. Default is attachment.","required":false,"type":"string","enum":["attachment","inline"]},{"name":"contentType","in":"query","description":"The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav","required":false,"type":"string"}],"responses":{"200":{"description":"Download location returned"},"202":{"description":"Accepted - Preparing file for download - try again soon."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDocumentsDocumentIdContent"},"post":{"tags":["Content Management"],"summary":"Replace the contents of a document.","description":"","operationId":"postDocumentsDocumentIdContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Replace Request","required":false,"schema":{"$ref":"#/definitions/ReplaceRequest"}},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReplaceResponse"}},"202":{"description":"Accepted - Ready for upload"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"409":{"description":"Resource conflict - Unexpected changeNumber was provided"},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDocumentsDocumentIdContent"}},"/api/v1/contentmanagement/query":{"get":{"tags":["Content Management"],"summary":"Query content","description":"","operationId":"getQuery","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"name or dateCreated","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"ascending or descending","required":false,"type":"string","default":"ascending"},{"name":"queryPhrase","in":"query","description":"Phrase tokens are ANDed together over all searchable fields","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl","workspace"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getQuery"},"post":{"tags":["Content Management"],"summary":"Query content","description":"","operationId":"postQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Allows for a filtered query returning facet information","required":true,"schema":{"$ref":"#/definitions/QueryRequest"}},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl","workspace"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQuery"}},"/api/v1/contentmanagement/securityprofiles":{"get":{"tags":["Content Management"],"summary":"Get a List of Security Profiles","description":"","operationId":"getSecurityprofiles","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecurityProfileEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSecurityprofiles"}},"/api/v1/contentmanagement/securityprofiles/{securityProfileId}":{"get":{"tags":["Content Management"],"summary":"Get a Security Profile","description":"","operationId":"getSecurityprofilesSecurityprofileId","produces":["application/json"],"parameters":[{"name":"securityProfileId","in":"path","description":"Security Profile Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecurityProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSecurityprofilesSecurityprofileId"}},"/api/v1/contentmanagement/shared/{sharedId}":{"get":{"tags":["Content Management"],"summary":"Get shared documents. Securely download a shared document.","description":"This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.","operationId":"getSharedSharedId","produces":["application/json"],"parameters":[{"name":"sharedId","in":"path","description":"Shared ID","required":true,"type":"string"},{"name":"redirect","in":"query","description":"Turn on or off redirect","required":false,"type":"boolean","default":true},{"name":"disposition","in":"query","description":"Request how the share content will be downloaded: attached as a file or inline. Default is attachment.","required":false,"type":"string","default":"attachment","enum":["attachment","inline","none"]},{"name":"contentType","in":"query","description":"The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["document.acl"]}],"responses":{"200":{"description":"Download location is returned in header, if redirect is set to false and disposition is not set to none. If disposition is none, location header will not be populated, DownloadUri and ViewUri will be populated."},"202":{"description":"Accepted - Preparing file for download - try again soon."},"307":{"description":"Redirected to download location, if redirect is set to true"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSharedSharedId"}},"/api/v1/contentmanagement/shares":{"get":{"tags":["Content Management"],"summary":"Gets a list of shares.  You must specify at least one filter (e.g. entityId).","description":"Failing to specify a filter will return 400.","operationId":"getShares","produces":["application/json"],"parameters":[{"name":"entityId","in":"query","description":"Filters the shares returned to only the entity specified by the value of this parameter.","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand share fields","required":false,"type":"string","enum":["member"]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShareEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getShares"},"post":{"tags":["Content Management"],"summary":"Creates a new share or updates an existing share if the entity has already been shared","description":"","operationId":"postShares","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CreateShareRequest - entity id and type and a single member or list of members are required","required":false,"schema":{"$ref":"#/definitions/CreateShareRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateShareResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postShares"}},"/api/v1/contentmanagement/shares/{shareId}":{"get":{"tags":["Content Management"],"summary":"Retrieve details about an existing share.","description":"","operationId":"getSharesShareId","produces":["application/json"],"parameters":[{"name":"shareId","in":"path","description":"Share ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand share fields","required":false,"type":"string","enum":["member"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Share"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSharesShareId"},"delete":{"tags":["Content Management"],"summary":"Deletes an existing share.","description":"This revokes sharing rights specified in the share record","operationId":"deleteSharesShareId","produces":["application/json"],"parameters":[{"name":"shareId","in":"path","description":"Share ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSharesShareId"}},"/api/v1/contentmanagement/status":{"get":{"tags":["Content Management"],"summary":"Get a list of statuses for pending operations","description":"","operationId":"getStatus","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommandStatusEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getStatus"}},"/api/v1/contentmanagement/status/{statusId}":{"get":{"tags":["Content Management"],"summary":"Get a status.","description":"","operationId":"getStatusStatusId","produces":["application/json"],"parameters":[{"name":"statusId","in":"path","description":"Status ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommandStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getStatusStatusId"},"delete":{"tags":["Content Management"],"summary":"Cancel the command for this status","description":"","operationId":"deleteStatusStatusId","produces":["application/json"],"parameters":[{"name":"statusId","in":"path","description":"Status ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteStatusStatusId"}},"/api/v1/contentmanagement/workspaces":{"get":{"tags":["Content Management"],"summary":"Get a list of workspaces.","description":"Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to.","operationId":"getWorkspaces","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"access","in":"query","description":"Requested access level","required":false,"type":"string","default":"document:viewmetadata","enum":["content","admin","document:create","document:viewContent","document:viewMetadata","document:download","document:delete","document:update","document:share","document:shareView","document:email","document:print","document:auditView","document:replace","document:tag","tag:create","tag:view","tag:update","tag:apply","tag:remove","tag:delete"]},{"name":"expand","in":"query","description":"Expand some workspace fields","required":false,"type":"string","enum":["summary","acl"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getWorkspaces"},"post":{"tags":["Content Management"],"summary":"Create a group workspace","description":"","operationId":"postWorkspaces","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Workspace","required":false,"schema":{"$ref":"#/definitions/WorkspaceCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postWorkspaces"}},"/api/v1/contentmanagement/workspaces/{workspaceId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace.","description":"","operationId":"getWorkspacesWorkspaceId","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand some workspace fields","required":false,"type":"string","enum":["summary","acl"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getWorkspacesWorkspaceId"},"put":{"tags":["Content Management"],"summary":"Update a workspace","description":"","operationId":"putWorkspacesWorkspaceId","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace","required":false,"schema":{"$ref":"#/definitions/Workspace"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putWorkspacesWorkspaceId"},"delete":{"tags":["Content Management"],"summary":"Delete a workspace","description":"","operationId":"deleteWorkspacesWorkspaceId","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"moveChildrenToWorkspaceId","in":"query","description":"New location for objects in deleted workspace.","required":false,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteWorkspacesWorkspaceId"}},"/api/v1/contentmanagement/workspaces/{workspaceId}/members":{"get":{"tags":["Content Management"],"summary":"Get a list workspace members","description":"","operationId":"getWorkspacesWorkspaceIdMembers","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand workspace member fields","required":false,"type":"string","enum":["member"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getWorkspacesWorkspaceIdMembers"}},"/api/v1/contentmanagement/workspaces/{workspaceId}/members/{memberId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace member","description":"","operationId":"getWorkspacesWorkspaceIdMembersMemberId","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand workspace member fields","required":false,"type":"string","enum":["member"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getWorkspacesWorkspaceIdMembersMemberId"},"put":{"tags":["Content Management"],"summary":"Add a member to a workspace","description":"","operationId":"putWorkspacesWorkspaceIdMembersMemberId","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace","required":false,"schema":{"$ref":"#/definitions/WorkspaceMember"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putWorkspacesWorkspaceIdMembersMemberId"},"delete":{"tags":["Content Management"],"summary":"Delete a member from a workspace","description":"","operationId":"deleteWorkspacesWorkspaceIdMembersMemberId","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteWorkspacesWorkspaceIdMembersMemberId"}},"/api/v1/contentmanagement/workspaces/{workspaceId}/tagvalues":{"get":{"tags":["Content Management"],"summary":"Get a list of workspace tags","description":"","operationId":"getWorkspacesWorkspaceIdTagvalues","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"value","in":"query","description":"filter the list of tags returned","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getWorkspacesWorkspaceIdTagvalues"},"post":{"tags":["Content Management"],"summary":"Create a workspace tag","description":"","operationId":"postWorkspacesWorkspaceIdTagvalues","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"tag","required":false,"schema":{"$ref":"#/definitions/TagValue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postWorkspacesWorkspaceIdTagvalues"}},"/api/v1/contentmanagement/workspaces/{workspaceId}/tagvalues/query":{"post":{"tags":["Content Management"],"summary":"Perform a prefix query on tags in the workspace","description":"","operationId":"postWorkspacesWorkspaceIdTagvaluesQuery","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"query","required":false,"schema":{"$ref":"#/definitions/TagQueryRequest"}},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postWorkspacesWorkspaceIdTagvaluesQuery"}},"/api/v1/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace tag","description":"","operationId":"getWorkspacesWorkspaceIdTagvaluesTagId","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getWorkspacesWorkspaceIdTagvaluesTagId"},"put":{"tags":["Content Management"],"summary":"Update a workspace tag. Will update all documents with the new tag value.","description":"","operationId":"putWorkspacesWorkspaceIdTagvaluesTagId","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace","required":false,"schema":{"$ref":"#/definitions/TagValue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"202":{"description":"Accepted - Processing Update"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putWorkspacesWorkspaceIdTagvaluesTagId"},"delete":{"tags":["Content Management"],"summary":"Delete workspace tag","description":"Delete a tag from a workspace. Will remove this tag from all documents.","operationId":"deleteWorkspacesWorkspaceIdTagvaluesTagId","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteWorkspacesWorkspaceIdTagvaluesTagId"}},"/api/v1/conversations":{"get":{"tags":["Conversations"],"summary":"Get conversations","description":"","operationId":"getConversations","produces":["application/json"],"parameters":[{"name":"communicationType","in":"query","description":"Call or Chat communication filtering","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversations"},"post":{"tags":["Conversations"],"summary":"Create conversation","description":"","operationId":"postConversations","produces":["application/json"],"parameters":[{"name":"call","in":"query","description":"Phone number to call","required":false,"type":"string"},{"name":"callFrom","in":"query","description":"Queue id to place the call from","required":false,"type":"string"},{"name":"callQueueId","in":"query","description":"Queue id to call","required":false,"type":"string"},{"name":"callUserId","in":"query","description":"User id to call (this will call the default number)","required":false,"type":"string"},{"name":"priority","in":"query","description":"Priority level to use for routing when calling a queue","required":false,"type":"integer","format":"int32"},{"name":"languageId","in":"query","description":"Language id to use for routing when calling a queue","required":false,"type":"string"},{"name":"skillIds","in":"query","description":"Skill ids to use for routing when calling a queue","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"in":"body","name":"body","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversations"}},"/api/v1/conversations/fax":{"post":{"tags":["Conversations"],"summary":"Create Fax Conversation","description":"","operationId":"postFax","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Fax","required":false,"schema":{"$ref":"#/definitions/FaxSendRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxSendResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postFax"}},"/api/v1/conversations/maximumconferenceparties":{"get":{"tags":["Conversations"],"summary":"Get the maximum number of participants that this user can have on a conference","description":"","operationId":"getMaximumconferenceparties","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MaxParticipants"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMaximumconferenceparties"}},"/api/v1/conversations/query":{"post":{"tags":["Conversations"],"summary":"Query historical conversations","description":"","operationId":"postQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Query parameters","required":true,"schema":{"$ref":"#/definitions/ConversationHistoricalQueryRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQuery"}},"/api/v1/conversations/query/{anchor}":{"post":{"tags":["Conversations"],"summary":"Query historical conversations with a date/time anchor","description":"","operationId":"postQueryAnchor","produces":["application/json"],"parameters":[{"name":"anchor","in":"path","description":"A point in time within the interval for the query that bounds the query. In the form of YYYYMMDDHHmmssSSSZX where YYYY is the 4-digit year, MM is the 2-digit month, DD is the 2-digit day-of-month, HH is the 2-digit hour-of-day (00-23), mm is the 2-digit minute, ss is the 2-digit second, SSS is the 3-digit millisecond, Z is the UTC offset expressed as 'Z', '+nnnn', '-nnnn', '+nn:nn', '-nn:nn', and X is either 'A' (for the anchor point being at the earliest point in the query) or 'D' (for the anchor point being the latest point in the query","required":true,"type":"string"},{"in":"body","name":"body","description":"Query parameters","required":true,"schema":{"$ref":"#/definitions/ConversationHistoricalQueryRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQueryAnchor"}},"/api/v1/conversations/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get conversation","description":"","operationId":"getConversationId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationId"},"put":{"tags":["Conversations"],"summary":"Update conversation","description":"","operationId":"putConversationId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":false,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putConversationId"}},"/api/v1/conversations/{conversationId}/calls":{"post":{"tags":["Conversations"],"summary":"Add a new call to a conversation","description":"","operationId":"postConversationIdCalls","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":false,"schema":{"$ref":"#/definitions/CallCommand"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdCalls"}},"/api/v1/conversations/{conversationId}/messages":{"get":{"tags":["Conversations"],"summary":"Get conversation messages","description":"","operationId":"getConversationIdMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessageListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdMessages"},"post":{"tags":["Conversations"],"summary":"Send an email reply","description":"","operationId":"postConversationIdMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Reply","required":false,"schema":{"$ref":"#/definitions/EmailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdMessages"}},"/api/v1/conversations/{conversationId}/messages/draft":{"get":{"tags":["Conversations"],"summary":"Get conversation draft reply","description":"","operationId":"getConversationIdMessagesDraft","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdMessagesDraft"},"put":{"tags":["Conversations"],"summary":"Update conversation draft reply","description":"","operationId":"putConversationIdMessagesDraft","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Draft","required":false,"schema":{"$ref":"#/definitions/EmailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putConversationIdMessagesDraft"}},"/api/v1/conversations/{conversationId}/messages/draft/attachments/{attachmentId}":{"delete":{"tags":["Conversations"],"summary":"Delete attachment from draft","description":"","operationId":"deleteConversationIdMessagesDraftAttachmentsAttachmentId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"attachmentId","in":"path","description":"attachment ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteConversationIdMessagesDraftAttachmentsAttachmentId"}},"/api/v1/conversations/{conversationId}/messages/{id}":{"get":{"tags":["Conversations"],"summary":"Get conversation message","description":"","operationId":"getConversationIdMessagesId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"id","in":"path","description":"message ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdMessagesId"}},"/api/v1/conversations/{conversationId}/participants":{"post":{"tags":["Conversations"],"summary":"Add participants to a conversation","description":"","operationId":"postConversationIdParticipants","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":false,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdParticipants"}},"/api/v1/conversations/{conversationId}/participants/{participantId}":{"put":{"tags":["Conversations"],"summary":"Update a participant.","description":"Specify the state as CONNECTED, DISCONNECTED. You can specify a wrap-up code.","operationId":"putConversationIdParticipantsParticipantId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putConversationIdParticipantsParticipantId"}},"/api/v1/conversations/{conversationId}/participants/{participantId}/attributes":{"put":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"putConversationIdParticipantsParticipantIdAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putConversationIdParticipantsParticipantIdAttributes"}},"/api/v1/conversations/{conversationId}/participants/{participantId}/callbacks":{"post":{"tags":["Conversations"],"summary":"Create a new callback for the specified participant on the conversation.","description":"","operationId":"postConversationIdParticipantsParticipantIdCallbacks","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateCallbackCommand"}}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdParticipantsParticipantIdCallbacks"}},"/api/v1/conversations/{conversationId}/participants/{participantId}/consult":{"post":{"tags":["Conversations"],"summary":"Initiate and update consult transfer","description":"","operationId":"postConversationIdParticipantsParticipantIdConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"The object of the transfer","required":true,"type":"string"},{"in":"body","name":"body","description":"Destination address & initial speak to","required":false,"schema":{"$ref":"#/definitions/ConsultTransfer"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdParticipantsParticipantIdConsult"},"put":{"tags":["Conversations"],"summary":"Change who can speak","description":"","operationId":"putConversationIdParticipantsParticipantIdConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"The object of the transfer","required":true,"type":"string"},{"in":"body","name":"body","description":"new speak to","required":false,"schema":{"$ref":"#/definitions/ConsultTransferUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putConversationIdParticipantsParticipantIdConsult"},"delete":{"tags":["Conversations"],"summary":"Cancel the transfer","description":"","operationId":"deleteConversationIdParticipantsParticipantIdConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"The object of the transfer","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteConversationIdParticipantsParticipantIdConsult"}},"/api/v1/conversations/{conversationId}/participants/{participantId}/monitor":{"post":{"tags":["Conversations"],"summary":"Listen in on the conversation from the point of view of a given participant.","description":"","operationId":"postConversationIdParticipantsParticipantIdMonitor","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdParticipantsParticipantIdMonitor"}},"/api/v1/conversations/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationIdParticipantsParticipantIdReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"name":"userId","in":"query","description":"The user that will replace this participant.  If address is not supplied then the user's Work address will be used.  This parameter is required when replacing a participant that has an active chat.","required":false,"type":"string"},{"name":"address","in":"query","description":"The address that will be used to contact the new participant","required":false,"type":"string"},{"name":"username","in":"query","description":"The username of the person that will replace this participant.  This field is only used if the userId is blank.","required":false,"type":"string"},{"name":"queueId","in":"query","description":"The id of the queue that will replace this participant.","required":false,"type":"string"},{"name":"voicemail","in":"query","description":"Indicates this participant will be replaced by the voicemail inbox of the participant.","required":false,"type":"boolean"}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdParticipantsParticipantIdReplace"}},"/api/v1/conversations/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationIdParticipantsParticipantIdWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdParticipantsParticipantIdWrapup"}},"/api/v1/conversations/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationIdParticipantsParticipantIdWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdParticipantsParticipantIdWrapupcodes"}},"/api/v1/conversations/{conversationId}/recordings":{"get":{"tags":["Recording"],"summary":"Get all of a Conversation's Recordings.","description":"","operationId":"getConversationIdRecordings","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"maxWaitMs","in":"query","description":"The maximum number of milliseconds to wait for the recording to be ready.","required":false,"type":"integer","default":5000,"format":"int32","enum":["Any integer greater than or equal to 0."]},{"name":"formatId","in":"query","description":"The desired format (WEBM, WAV, etc.)","required":false,"type":"string","default":"WEBM","enum":["WEBM","WAV"]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Recording"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdRecordings"}},"/api/v1/conversations/{conversationId}/recordings/{recordingId}":{"get":{"tags":["Recording"],"summary":"Gets a specific recording.","description":"","operationId":"getConversationIdRecordingsRecordingId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"maxWaitMs","in":"query","description":"The maximum number of milliseconds to wait for completion.","required":false,"type":"integer","format":"int32","enum":["Any integer greater than or equal to 0."]},{"name":"formatId","in":"query","description":"The desired format (WEBM, WAV, etc.)","required":false,"type":"string","default":"WEBM","enum":["WEBM","WAV"]},{"name":"download","in":"query","description":"requesting a download format of the recording","required":false,"type":"boolean","default":false,"enum":["true","false"]},{"name":"fileName","in":"query","description":"the name of the downloaded fileName","required":false,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdRecordingsRecordingId"},"put":{"tags":["Recording"],"summary":"Updates the retention records on a recording.","description":"Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. Use of the query parameter 'restoreDays' is deprecated and will be removed in the next major version release. If 'restoreDays' is provided, no attempt at updating other retention data will be made. To migrate to the new usage, issuing a request with restoreDays=10 would instead set the archiveDate's time stamp in the PUT body to 10 days in the future.","operationId":"putConversationIdRecordingsRecordingId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"in":"body","name":"body","description":"recording","required":true,"schema":{"$ref":"#/definitions/Recording"}},{"name":"restoreDays","in":"query","description":"The number of days the recording will be available before it is re-archived. Deprecated.","required":false,"type":"integer","format":"int32","enum":["Any integer greater than or equal to 1."]}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putConversationIdRecordingsRecordingId"}},"/api/v1/conversations/{conversationId}/recordings/{recordingId}/annotations":{"get":{"tags":["Recording"],"summary":"Get annotations for recording","description":"","operationId":"getConversationIdRecordingsRecordingIdAnnotations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Annotation"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdRecordingsRecordingIdAnnotations"},"post":{"tags":["Recording"],"summary":"Create annotation","description":"","operationId":"postConversationIdRecordingsRecordingIdAnnotations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"in":"body","name":"body","description":"annotation","required":false,"schema":{"$ref":"#/definitions/Annotation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdRecordingsRecordingIdAnnotations"}},"/api/v1/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}":{"get":{"tags":["Recording"],"summary":"Get annotation","description":"","operationId":"getConversationIdRecordingsRecordingIdAnnotationsAnnotationId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdRecordingsRecordingIdAnnotationsAnnotationId"},"put":{"tags":["Recording"],"summary":"Update annotation","description":"","operationId":"putConversationIdRecordingsRecordingIdAnnotationsAnnotationId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"annotation","required":false,"schema":{"$ref":"#/definitions/Annotation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putConversationIdRecordingsRecordingIdAnnotationsAnnotationId"},"delete":{"tags":["Recording"],"summary":"Delete annotation","description":"","operationId":"deleteConversationIdRecordingsRecordingIdAnnotationsAnnotationId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteConversationIdRecordingsRecordingIdAnnotationsAnnotationId"}},"/api/v1/conversations/{conversationId}/tags":{"get":{"tags":["Conversations"],"summary":"Get possible tags for Conversation","description":"","operationId":"getConversationIdTags","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Tag"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdTags"}},"/api/v1/conversations/{conversationId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get possible wrap-up codes for Conversation","description":"","operationId":"getConversationIdWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdWrapupcodes"}},"/api/v1/date":{"get":{"tags":["Utilities"],"summary":"Get the current system date/time","description":"","operationId":"getDate","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServerDate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDate"}},"/api/v1/downloads/callback":{"get":{"tags":["Downloads"],"summary":"OAuth Callback used during code authorization grant flow.","description":"","operationId":"getCallback","produces":["application/json"],"parameters":[{"name":"code","in":"query","required":false,"type":"string"},{"name":"state","in":"query","required":false,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallback"}},"/api/v1/downloads/{downloadId}":{"get":{"tags":["Downloads"],"summary":"Issues a redirect to a signed secure download URL for specified download","description":"this method will issue a redirect to the url to the content","operationId":"getDownloadId","produces":["application/json"],"parameters":[{"name":"downloadId","in":"path","description":"Download ID","required":true,"type":"string"},{"name":"contentDisposition","in":"query","required":false,"type":"string","default":"attachment"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDownloadId"}},"/api/v1/externalcontacts/contacts":{"get":{"tags":["External Contacts"],"summary":"Search for External Contacts","description":"","operationId":"getContacts","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"User supplied search keywords (no special syntax is currently supported)","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["[externalOrganization]"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContacts"},"post":{"tags":["External Contacts"],"summary":"Create an ExternalContact","description":"","operationId":"postContacts","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExternalContact","required":false,"schema":{"$ref":"#/definitions/ExternalContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postContacts"}},"/api/v1/externalcontacts/contacts/{contactId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a ExternalContact","description":"","operationId":"getContactsContactId","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["[externalOrganization]"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContactsContactId"},"put":{"tags":["External Contacts"],"summary":"Update a externalContact","description":"","operationId":"putContactsContactId","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":false,"schema":{"$ref":"#/definitions/ExternalContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putContactsContactId"},"delete":{"tags":["External Contacts"],"summary":"Delete a contact","description":"","operationId":"deleteContactsContactId","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteContactsContactId"}},"/api/v1/externalcontacts/contacts/{contactId}/notes":{"get":{"tags":["External Contacts"],"summary":"List Notes for an ExternalContact","description":"","operationId":"getContactsContactIdNotes","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NoteListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContactsContactIdNotes"},"post":{"tags":["External Contacts"],"summary":"Create a Note for an ExternalContact","description":"","operationId":"postContactsContactIdNotes","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":false,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postContactsContactIdNotes"}},"/api/v1/externalcontacts/contacts/{contactId}/notes/{noteId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a note for a contact","description":"","operationId":"getContactsContactIdNotesNoteId","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContactsContactIdNotesNoteId"},"put":{"tags":["External Contacts"],"summary":"Update a note for a contact","description":"","operationId":"putContactsContactIdNotesNoteId","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Note","required":false,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putContactsContactIdNotesNoteId"},"delete":{"tags":["External Contacts"],"summary":"Delete a note for a contact","description":"","operationId":"deleteContactsContactIdNotesNoteId","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteContactsContactIdNotesNoteId"}},"/api/v1/externalcontacts/organizations":{"get":{"tags":["External Contacts"],"summary":"Search for External Organizations","description":"","operationId":"getOrganizations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"Search query","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganizationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrganizations"},"post":{"tags":["External Contacts"],"summary":"Create an External Organization","description":"","operationId":"postOrganizations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExternalOrganization","required":false,"schema":{"$ref":"#/definitions/ExternalOrganization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postOrganizations"}},"/api/v1/externalcontacts/organizations/{externalOrganizationId}":{"get":{"tags":["External Contacts"],"summary":"Fetch an External Organization","description":"","operationId":"getOrganizationsExternalorganizationId","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrganizationsExternalorganizationId"},"put":{"tags":["External Contacts"],"summary":"Update an External Organization","description":"","operationId":"putOrganizationsExternalorganizationId","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalOrganization","required":false,"schema":{"$ref":"#/definitions/ExternalOrganization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putOrganizationsExternalorganizationId"},"delete":{"tags":["External Contacts"],"summary":"Delete an External Organization","description":"","operationId":"deleteOrganizationsExternalorganizationId","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteOrganizationsExternalorganizationId"}},"/api/v1/externalcontacts/organizations/{externalOrganizationId}/contacts":{"get":{"tags":["External Contacts"],"summary":"Search for External Contacts","description":"","operationId":"getOrganizationsExternalorganizationIdContacts","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"User supplied search keywords (no special syntax is currently supported)","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["[externalOrganization]"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrganizationsExternalorganizationIdContacts"}},"/api/v1/externalcontacts/organizations/{externalOrganizationId}/notes":{"get":{"tags":["External Contacts"],"summary":"List Notes for an External Organization","description":"","operationId":"getOrganizationsExternalorganizationIdNotes","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NoteListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrganizationsExternalorganizationIdNotes"},"post":{"tags":["External Contacts"],"summary":"Create a Note for an External Organization","description":"","operationId":"postOrganizationsExternalorganizationIdNotes","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":false,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postOrganizationsExternalorganizationIdNotes"}},"/api/v1/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a note","description":"","operationId":"getOrganizationsExternalorganizationIdNotesNoteId","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrganizationsExternalorganizationIdNotesNoteId"},"put":{"tags":["External Contacts"],"summary":"Update a note","description":"","operationId":"putOrganizationsExternalorganizationIdNotesNoteId","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Note","required":false,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putOrganizationsExternalorganizationIdNotesNoteId"},"delete":{"tags":["External Contacts"],"summary":"Delete a note","description":"","operationId":"deleteOrganizationsExternalorganizationIdNotesNoteId","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteOrganizationsExternalorganizationIdNotesNoteId"}},"/api/v1/externalcontacts/organizations/{externalOrganizationId}/relationships":{"get":{"tags":["External Contacts"],"summary":"Fetch an External Organization","description":"","operationId":"getOrganizationsExternalorganizationIdRelationships","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RelationshipListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrganizationsExternalorganizationIdRelationships"}},"/api/v1/externalcontacts/relationships":{"post":{"tags":["External Contacts"],"summary":"Create a relationship","description":"","operationId":"postRelationships","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Relationship","required":false,"schema":{"$ref":"#/definitions/Relationship"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRelationships"}},"/api/v1/externalcontacts/relationships/{relationshipId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a relationship","description":"","operationId":"getRelationshipsRelationshipId","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRelationshipsRelationshipId"},"put":{"tags":["External Contacts"],"summary":"Update a relationship","description":"","operationId":"putRelationshipsRelationshipId","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Relationship","required":false,"schema":{"$ref":"#/definitions/Relationship"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRelationshipsRelationshipId"},"delete":{"tags":["External Contacts"],"summary":"Delete a relationship","description":"","operationId":"deleteRelationshipsRelationshipId","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteRelationshipsRelationshipId"}},"/api/v1/fax/documents":{"get":{"tags":["Fax"],"summary":"Get a list of fax documents.","description":"","operationId":"getDocuments","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocumentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDocuments"}},"/api/v1/fax/documents/{documentId}":{"get":{"tags":["Fax"],"summary":"Get a document.","description":"","operationId":"getDocumentsDocumentId","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDocumentsDocumentId"},"put":{"tags":["Fax"],"summary":"Update a fax document.","description":"","operationId":"putDocumentsDocumentId","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Document","required":false,"schema":{"$ref":"#/definitions/FaxDocument"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putDocumentsDocumentId"},"delete":{"tags":["Fax"],"summary":"Delete a fax document.","description":"","operationId":"deleteDocumentsDocumentId","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteDocumentsDocumentId"}},"/api/v1/fax/documents/{documentId}/content":{"get":{"tags":["Fax"],"summary":"Download a fax document.","description":"","operationId":"getDocumentsDocumentIdContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DownloadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDocumentsDocumentIdContent"}},"/api/v1/fax/summary":{"get":{"tags":["Fax"],"summary":"Get fax summary","description":"","operationId":"getSummary","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxSummary"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSummary"}},"/api/v1/flows":{"get":{"tags":["Architect"],"summary":"Get a pageable list of flows, filtered by query parameters","description":"Multiple IDs can be specified, in which case all matching flows will be returned, and no other parameters will be evaluated.","operationId":"getFlows","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"Type","required":false,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"},{"name":"publishVersionId","in":"query","description":"Publish version ID","required":false,"type":"string"},{"name":"editableBy","in":"query","description":"Editable by","required":false,"type":"string"},{"name":"lockedBy","in":"query","description":"Locked by","required":false,"type":"string"},{"name":"deleted","in":"query","description":"Include deleted","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFlows"},"post":{"tags":["Architect"],"summary":"Create flow","description":"","operationId":"postFlows","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Flow"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postFlows"},"delete":{"tags":["Architect"],"summary":"Batch-delete a list of flows","description":"Multiple IDs can be specified, in which case all specified flows will be deleted.","operationId":"deleteFlows","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"List of Flow IDs","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"ignoreDependencies","in":"query","description":"Ignore Dependencies","required":false,"type":"boolean","default":false}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteFlows"}},"/api/v1/flows/actions/checkin":{"post":{"tags":["Architect"],"summary":"Check-in flow","description":"","operationId":"postActionsCheckin","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postActionsCheckin"}},"/api/v1/flows/actions/checkout":{"post":{"tags":["Architect"],"summary":"Check-out flow","description":"","operationId":"postActionsCheckout","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postActionsCheckout"}},"/api/v1/flows/actions/deactivate":{"post":{"tags":["Architect"],"summary":"Deactivate flow","description":"","operationId":"postActionsDeactivate","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postActionsDeactivate"}},"/api/v1/flows/actions/debug":{"post":{"tags":["Architect"],"summary":"Debug flow","description":"","operationId":"postActionsDebug","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow","required":false,"type":"string"},{"name":"version","in":"query","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postActionsDebug"}},"/api/v1/flows/actions/revert":{"post":{"tags":["Architect"],"summary":"Revert flow","description":"","operationId":"postActionsRevert","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postActionsRevert"}},"/api/v1/flows/{flowId}":{"get":{"tags":["Architect"],"summary":"Get flow.","description":"","operationId":"getFlowId","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFlowId"},"put":{"tags":["Architect"],"summary":"Update flow.","description":"","operationId":"putFlowId","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Flow"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putFlowId"},"delete":{"tags":["Architect"],"summary":"Delete flow.","description":"","operationId":"deleteFlowId","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteFlowId"}},"/api/v1/flows/{flowId}/latestconfiguration":{"get":{"tags":["Architect"],"summary":"Get the latest configuration for flow.","description":"","operationId":"getFlowIdLatestconfiguration","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFlowIdLatestconfiguration"}},"/api/v1/flows/{flowId}/publishedresults/{id}":{"get":{"tags":["Architect"],"summary":"Get generation result.","description":"","operationId":"getFlowIdPublishedresultsId","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"id","in":"path","description":"Publish Result ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PublishedResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFlowIdPublishedresultsId"}},"/api/v1/flows/{flowId}/versions":{"get":{"tags":["Architect"],"summary":"Get flow version list","description":"","operationId":"getFlowIdVersions","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"deleted","in":"query","description":"Deleted","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowVersionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFlowIdVersions"},"post":{"tags":["Architect"],"summary":"Create flow version","description":"","operationId":"postFlowIdVersions","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postFlowIdVersions"}},"/api/v1/flows/{flowId}/versions/{versionId}":{"get":{"tags":["Architect"],"summary":"Get flow version","description":"","operationId":"getFlowIdVersionsVersionId","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Version ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFlowIdVersionsVersionId"}},"/api/v1/flows/{flowId}/versions/{versionId}/configuration":{"get":{"tags":["Architect"],"summary":"Create flow version configuration","description":"","operationId":"getFlowIdVersionsVersionIdConfiguration","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Version ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFlowIdVersionsVersionIdConfiguration"}},"/api/v1/geolocations/settings":{"get":{"tags":["Geolocation"],"summary":"Get a organization's GeolocationSettings","description":"","operationId":"getSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeolocationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSettings"},"patch":{"tags":["Geolocation"],"summary":"Patch a organization's GeolocationSettings","description":"","operationId":"patchSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/GeolocationSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeolocationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchSettings"}},"/api/v1/greetings":{"get":{"tags":["Greetings"],"summary":"Gets an Organization's Greetings","description":"","operationId":"getGreetings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getGreetings"},"post":{"tags":["Greetings"],"summary":"Create a Greeting for an Organization","description":"","operationId":"postGreetings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Greeting to create","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postGreetings"}},"/api/v1/greetings/defaults":{"get":{"tags":["Greetings"],"summary":"Get an Organization's DefaultGreetingList","description":"","operationId":"getDefaults","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDefaults"},"put":{"tags":["Greetings"],"summary":"Update an Organization's DefaultGreetingList","description":"","operationId":"putDefaults","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The updated defaultGreetingList","required":true,"schema":{"$ref":"#/definitions/DefaultGreetingList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putDefaults"}},"/api/v1/greetings/{greetingId}":{"get":{"tags":["Greetings"],"summary":"Get a Greeting with the given GreetingId","description":"","operationId":"getGreetingId","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getGreetingId"},"put":{"tags":["Greetings"],"summary":"Updates the Greeting with the given GreetingId","description":"","operationId":"putGreetingId","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated Greeting","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putGreetingId"},"delete":{"tags":["Greetings"],"summary":"Deletes a Greeting with the given GreetingId","description":"","operationId":"deleteGreetingId","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteGreetingId"}},"/api/v1/greetings/{greetingId}/media":{"get":{"tags":["Greetings"],"summary":"Get media playback URI for this greeting","description":"","operationId":"getGreetingIdMedia","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired format (WAV, etc.)","required":false,"type":"string","default":"WAV","enum":["WAV"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GreetingMediaInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getGreetingIdMedia"}},"/api/v1/groups":{"get":{"tags":["Groups"],"summary":"Get a group list","description":"","operationId":"getGroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["[ascending","descending]"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getGroups"}},"/api/v1/groups/{groupId}":{"get":{"tags":["Groups"],"summary":"Get group","description":"","operationId":"getGroupId","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getGroupId"}},"/api/v1/groups/{groupId}/members":{"get":{"tags":["Groups"],"summary":"Get group members","description":"","operationId":"getGroupIdMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["[ascending","descending]"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getGroupIdMembers"}},"/api/v1/health/check":{"get":{"tags":["Utilities"],"summary":"Get health.","description":"","operationId":"getCheck","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HealthCheckInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCheck"}},"/api/v1/identityproviders":{"get":{"tags":["OAuth"],"summary":"The list of identity providers","description":"","operationId":"getIdentityproviders","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProviderEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getIdentityproviders"}},"/api/v1/identityproviders/okta":{"get":{"tags":["OAuth"],"summary":"Get Okta Identity Provider","description":"","operationId":"getOkta","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Okta"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOkta"},"put":{"tags":["OAuth"],"summary":"Update/Create Okta Identity Provider","description":"","operationId":"putOkta","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":false,"schema":{"$ref":"#/definitions/Okta"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putOkta"},"delete":{"tags":["OAuth"],"summary":"Delete Okta Identity Provider","description":"","operationId":"deleteOkta","produces":["application/json"],"parameters":[],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteOkta"}},"/api/v1/identityproviders/onelogin":{"get":{"tags":["OAuth"],"summary":"Get OneLogin Identity Provider","description":"","operationId":"getOnelogin","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OneLogin"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOnelogin"},"put":{"tags":["OAuth"],"summary":"Update/Create OneLogin Identity Provider","description":"","operationId":"putOnelogin","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":false,"schema":{"$ref":"#/definitions/OneLogin"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putOnelogin"},"delete":{"tags":["OAuth"],"summary":"Delete OneLogin Identity Provider","description":"","operationId":"deleteOnelogin","produces":["application/json"],"parameters":[],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteOnelogin"}},"/api/v1/identityproviders/purecloud":{"get":{"tags":["OAuth"],"summary":"Get PureCloud Identity Provider","description":"","operationId":"getPurecloud","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PureCloud"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPurecloud"},"put":{"tags":["OAuth"],"summary":"Update/Create PureCloud Identity Provider","description":"","operationId":"putPurecloud","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":false,"schema":{"$ref":"#/definitions/PureCloud"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putPurecloud"},"delete":{"tags":["OAuth"],"summary":"Delete PureCloud Identity Provider","description":"","operationId":"deletePurecloud","produces":["application/json"],"parameters":[],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deletePurecloud"}},"/api/v1/identityproviders/salesforce":{"get":{"tags":["OAuth"],"summary":"Get Salesforce Identity Provider","description":"","operationId":"getSalesforce","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Salesforce"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSalesforce"},"put":{"tags":["OAuth"],"summary":"Update/Create Salesforce Identity Provider","description":"","operationId":"putSalesforce","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":false,"schema":{"$ref":"#/definitions/Salesforce"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSalesforce"},"delete":{"tags":["OAuth"],"summary":"Delete Salesforce Identity Provider","description":"","operationId":"deleteSalesforce","produces":["application/json"],"parameters":[],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSalesforce"}},"/api/v1/identityproviders/{providerId}":{"get":{"tags":["OAuth"],"summary":"Get an identity provider","description":"","operationId":"getProviderId","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProviderId"},"put":{"tags":["OAuth"],"summary":"Update an identity provider","description":"","operationId":"putProviderId","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":false,"schema":{"$ref":"#/definitions/OAuthProvider"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProviderId"},"delete":{"tags":["OAuth"],"summary":"Delete an identity provider","description":"","operationId":"deleteProviderId","produces":["application/json"],"parameters":[],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProviderId"}},"/api/v1/languages":{"get":{"tags":["Languages"],"summary":"Get the list of supported languages.","description":"","operationId":"getLanguages","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["[ascending","descending]"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LanguageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLanguages"}},"/api/v1/languages/{languageId}":{"get":{"tags":["Languages"],"summary":"Get language","description":"","operationId":"getLanguageId","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLanguageId"}},"/api/v1/licensing/licenses":{"get":{"tags":["Licensing"],"summary":"Get Licenses required for a set of permissions.","description":"","operationId":"getLicenses","produces":["application/json"],"parameters":[{"name":"permission","in":"query","description":"Permission","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/License"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLicenses"}},"/api/v1/licensing/orgassignments":{"get":{"tags":["Licensing"],"summary":"Get org license assignments.","description":"","operationId":"getOrgassignments","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrgLicenseAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrgassignments"}},"/api/v1/licensing/orgassignments/{id}":{"get":{"tags":["Licensing"],"summary":"Get org license assignment.","description":"","operationId":"getOrgassignmentsId","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrgLicenseAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrgassignmentsId"}},"/api/v1/licensing/permissions":{"get":{"tags":["Licensing"],"summary":"Get Licenses required per permission.","description":"","operationId":"getPermissions","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/LicensesByPermission"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPermissions"},"post":{"tags":["Licensing"],"summary":"Get Licenses required per permission.","description":"","operationId":"postPermissions","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"in":"body","name":"body","description":"The permissions details","required":false,"schema":{"$ref":"#/definitions/Permissions"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/LicensesByPermission"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postPermissions"}},"/api/v1/licensing/userassignments":{"get":{"tags":["Licensing"],"summary":"Get user license assignments.","description":"","operationId":"getUserassignments","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserLicenseAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserassignments"}},"/api/v1/licensing/userassignments/{id}":{"get":{"tags":["Licensing"],"summary":"Get user license assignment.","description":"","operationId":"getUserassignmentsId","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserLicenseAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserassignmentsId"}},"/api/v1/locations":{"get":{"tags":["Locations"],"summary":"Get the list of locations.","description":"","operationId":"getLocations","produces":["application/json"],"parameters":[{"name":"state","in":"query","description":"Location state","required":false,"type":"string","default":"ACTIVE","enum":["ACTIVE","DELETED"]},{"name":"name","in":"query","description":"Location name","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLocations"}},"/api/v1/locations/{locationId}":{"get":{"tags":["Locations"],"summary":"Get Location by ID.","description":"","operationId":"getLocationId","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Location"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLocationId"}},"/api/v1/notifications/availabletopics":{"get":{"tags":["Notifications"],"summary":"Get available notification topics.","description":"","operationId":"getAvailabletopics","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getAvailabletopics"}},"/api/v1/notifications/channels":{"get":{"tags":["Notifications"],"summary":"The list of existing channels","description":"","operationId":"getChannels","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getChannels"},"post":{"tags":["Notifications"],"summary":"Create a new channel","description":"There is a limit of 10 channels. Creating an 11th channel will remove the channel with oldest last used date.","operationId":"postChannels","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Channel"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postChannels"}},"/api/v1/notifications/channels/{channelId}/subscriptions":{"get":{"tags":["Notifications"],"summary":"The list of all subscriptions for this channel","description":"","operationId":"getChannelsChannelIdSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getChannelsChannelIdSubscriptions"},"post":{"tags":["Notifications"],"summary":"Add a list of subscriptions to the existing list of subscriptions","description":"","operationId":"postChannelsChannelIdSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Topic","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/ChannelTopic"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postChannelsChannelIdSubscriptions"},"put":{"tags":["Notifications"],"summary":"Replace the current list of subscriptions with a new list.","description":"","operationId":"putChannelsChannelIdSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Topic","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/ChannelTopic"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putChannelsChannelIdSubscriptions"},"delete":{"tags":["Notifications"],"summary":"Remove all subscriptions","description":"","operationId":"deleteChannelsChannelIdSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteChannelsChannelIdSubscriptions"}},"/api/v1/oauth/clients":{"get":{"tags":["OAuth"],"summary":"The list of OAuth clients","description":"","operationId":"getClients","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClientEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getClients"},"post":{"tags":["OAuth"],"summary":"Create OAuth client","description":"The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. \nThe preferred authorizedGrantTypes is 'CODE' which requires applications to send a client ID and client secret. This is typically a web server. \nIf the client is unable to secure the client secret then the 'TOKEN' grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. \nIf a client is to be used outside of the context of a user then the 'CLIENT-CREDENTIALS' grant may be used. In this case the client must be granted roles \nvia the 'roleIds' field.","operationId":"postClients","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Client","required":false,"schema":{"$ref":"#/definitions/OAuthClient"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postClients"}},"/api/v1/oauth/clients/{clientId}":{"get":{"tags":["OAuth"],"summary":"Get OAuth Client","description":"","operationId":"getClientsClientId","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getClientsClientId"},"put":{"tags":["OAuth"],"summary":"Update OAuth Client","description":"","operationId":"putClientsClientId","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Client","required":false,"schema":{"$ref":"#/definitions/OAuthClient"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putClientsClientId"},"delete":{"tags":["OAuth"],"summary":"Delete OAuth Client","description":"","operationId":"deleteClientsClientId","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteClientsClientId"}},"/api/v1/oauth/clients/{clientId}/secret":{"post":{"tags":["OAuth"],"summary":"Regenerate Client Secret","description":"This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.","operationId":"postClientsClientIdSecret","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postClientsClientIdSecret"}},"/api/v1/orphanrecordings":{"get":{"tags":["Recording"],"summary":"Gets all orphan recordings","description":"","operationId":"getOrphanrecordings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecordingListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrphanrecordings"}},"/api/v1/orphanrecordings/{orphanId}":{"get":{"tags":["Recording"],"summary":"Gets a single orphan recording","description":"","operationId":"getOrphanId","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrphanId"},"delete":{"tags":["Recording"],"summary":" deletes a single orphan recording","description":"","operationId":"deleteOrphanId","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteOrphanId"}},"/api/v1/outbound/audits":{"post":{"tags":["Outbound"],"summary":"Retrieves audits for dialer.","description":"","operationId":"postAudits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"AuditSearch","required":false,"schema":{"$ref":"#/definitions/DialerAuditRequest"}},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"entity.name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"},{"name":"facetsOnly","in":"query","description":"Facets only","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditSearchResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postAudits"}},"/api/v1/outbound/callabletimesets":{"get":{"tags":["Outbound"],"summary":"Query callable time set list","description":"","operationId":"getCallabletimesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"PREFIX","enum":["EQUALS","REGEX","CONTAINS","PREFIX","LESSTHAN","LESSTHANEQUALTO","GREATERTHAN","GREATERTHANEQUALTO","BEGINSWITH","ENDSWITH"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallabletimesets"},"post":{"tags":["Outbound"],"summary":"Create callable time set","description":"","operationId":"postCallabletimesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"DialerCallableTimeSet","required":false,"schema":{"$ref":"#/definitions/CallableTimeSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallabletimesets"}},"/api/v1/outbound/callabletimesets/{callableTimeSetId}":{"get":{"tags":["Outbound"],"summary":"Get callable time set","description":"","operationId":"getCallabletimesetsCallabletimesetId","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallabletimesetsCallabletimesetId"},"put":{"tags":["Outbound"],"summary":"Update callable time set","description":"","operationId":"putCallabletimesetsCallabletimesetId","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DialerCallableTimeSet","required":false,"schema":{"$ref":"#/definitions/CallableTimeSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putCallabletimesetsCallabletimesetId"},"delete":{"tags":["Outbound"],"summary":"Delete callable time set","description":"","operationId":"deleteCallabletimesetsCallabletimesetId","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCallabletimesetsCallabletimesetId"}},"/api/v1/outbound/callanalysisresponsesets":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer call analysis response sets.","description":"","operationId":"getCallanalysisresponsesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"PREFIX","enum":["EQUALS","REGEX","CONTAINS","PREFIX","LESSTHAN","LESSTHANEQUALTO","GREATERTHAN","GREATERTHANEQUALTO","BEGINSWITH","ENDSWITH"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallanalysisresponsesets"},"post":{"tags":["Outbound"],"summary":"Create a dialer call analysis response set.","description":"","operationId":"postCallanalysisresponsesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ResponseSet","required":false,"schema":{"$ref":"#/definitions/ResponseSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallanalysisresponsesets"}},"/api/v1/outbound/callanalysisresponsesets/{callAnalysisSetId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer call analysis response set.","description":"","operationId":"getCallanalysisresponsesetsCallanalysissetId","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallanalysisresponsesetsCallanalysissetId"},"put":{"tags":["Outbound"],"summary":"Update a dialer call analysis response set.","description":"","operationId":"putCallanalysisresponsesetsCallanalysissetId","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ResponseSet","required":false,"schema":{"$ref":"#/definitions/ResponseSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putCallanalysisresponsesetsCallanalysissetId"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer call analysis response set.","description":"","operationId":"deleteCallanalysisresponsesetsCallanalysissetId","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCallanalysisresponsesetsCallanalysissetId"}},"/api/v1/outbound/campaigns":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer campaigns.","description":"","operationId":"getCampaigns","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"PREFIX","enum":["EQUALS","REGEX","CONTAINS","PREFIX","LESSTHAN","LESSTHANEQUALTO","GREATERTHAN","GREATERTHANEQUALTO","BEGINSWITH","ENDSWITH"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"contactListId","in":"query","description":"Contact List ID","required":false,"type":"string"},{"name":"dncListId","in":"query","description":"DNC list ID","required":false,"type":"string"},{"name":"distributionQueueId","in":"query","description":"Distribution queue ID","required":false,"type":"string"},{"name":"edgeGroupId","in":"query","description":"Edge group ID","required":false,"type":"string"},{"name":"callAnalysisResponseSetId","in":"query","description":"Call analysis response set ID","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCampaigns"},"post":{"tags":["Outbound"],"summary":"Create a campaign.","description":"","operationId":"postCampaigns","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Campaign","required":false,"schema":{"$ref":"#/definitions/Campaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCampaigns"}},"/api/v1/outbound/campaigns/progress":{"post":{"tags":["Outbound"],"summary":"Get progress for a list of campaigns","description":"","operationId":"postCampaignsProgress","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Campaign IDs","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignProgress"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCampaignsProgress"}},"/api/v1/outbound/campaigns/{campaignId}":{"get":{"tags":["Outbound"],"summary":"Get dialer campaign.","description":"","operationId":"getCampaignsCampaignId","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCampaignsCampaignId"},"put":{"tags":["Outbound"],"summary":"Update a campaign.","description":"","operationId":"putCampaignsCampaignId","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Campaign","required":false,"schema":{"$ref":"#/definitions/Campaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putCampaignsCampaignId"},"delete":{"tags":["Outbound"],"summary":"Delete a campaign.","description":"","operationId":"deleteCampaignsCampaignId","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCampaignsCampaignId"}},"/api/v1/outbound/campaigns/{campaignId}/agents/{userId}":{"put":{"tags":["Outbound"],"summary":"Send notification that an agent's state changed ","description":"New agent state.","operationId":"putCampaignsCampaignIdAgentsUserId","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"name":"userId","in":"path","description":"Agent's user ID","required":true,"type":"string"},{"in":"body","name":"body","description":"agent","required":false,"schema":{"$ref":"#/definitions/Agent"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putCampaignsCampaignIdAgentsUserId"}},"/api/v1/outbound/campaigns/{campaignId}/callback/schedule":{"post":{"tags":["Outbound"],"summary":"Schedule a Callback for a Dialer Campaign","description":"","operationId":"postCampaignsCampaignIdCallbackSchedule","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactCallbackRequest","required":false,"schema":{"$ref":"#/definitions/ContactCallbackRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactCallbackRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCampaignsCampaignIdCallbackSchedule"}},"/api/v1/outbound/campaigns/{campaignId}/diagnostics":{"get":{"tags":["Outbound"],"summary":"Get campaign diagnostics","description":"","operationId":"getCampaignsCampaignIdDiagnostics","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignDiagnostics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCampaignsCampaignIdDiagnostics"}},"/api/v1/outbound/campaigns/{campaignId}/progress":{"get":{"tags":["Outbound"],"summary":"Get campaign progress","description":"","operationId":"getCampaignsCampaignIdProgress","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignProgress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCampaignsCampaignIdProgress"},"delete":{"tags":["Outbound"],"summary":"Reset campaign progress and recycle the campaign","description":"","operationId":"deleteCampaignsCampaignIdProgress","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"202":{"description":"Accepted - the campaign will be recycled momentarily"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCampaignsCampaignIdProgress"}},"/api/v1/outbound/campaigns/{campaignId}/stats":{"get":{"tags":["Outbound"],"summary":"Get statistics about a Dialer Campaign","description":"","operationId":"getCampaignsCampaignIdStats","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignStats"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCampaignsCampaignIdStats"}},"/api/v1/outbound/contactlists":{"get":{"tags":["Outbound"],"summary":"Query a list of contact lists.","description":"","operationId":"getContactlists","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"importStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"PREFIX","enum":["EQUALS","REGEX","CONTAINS","PREFIX","LESSTHAN","LESSTHANEQUALTO","GREATERTHAN","GREATERTHANEQUALTO","BEGINSWITH","ENDSWITH"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContactlists"},"post":{"tags":["Outbound"],"summary":"Create a contact List.","description":"","operationId":"postContactlists","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ContactList","required":false,"schema":{"$ref":"#/definitions/ContactList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postContactlists"}},"/api/v1/outbound/contactlists/penetrationrates":{"post":{"tags":["Outbound"],"summary":"Get penetration rates for a list of penetration rate identifiers (contact list id and qualifier id)","description":"","operationId":"postContactlistsPenetrationrates","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"PenetrationRateIdentifierList","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/PenetrationRateId"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/PenetrationRate"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postContactlistsPenetrationrates"}},"/api/v1/outbound/contactlists/{contactListId}":{"get":{"tags":["Outbound"],"summary":"Get dialer contactList.","description":"","operationId":"getContactlistsContactlistId","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"importStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContactlistsContactlistId"},"put":{"tags":["Outbound"],"summary":"Update a contact list.","description":"","operationId":"putContactlistsContactlistId","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactList","required":false,"schema":{"$ref":"#/definitions/ContactList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putContactlistsContactlistId"},"delete":{"tags":["Outbound"],"summary":"Delete a contact list.","description":"","operationId":"deleteContactlistsContactlistId","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteContactlistsContactlistId"}},"/api/v1/outbound/contactlists/{contactListId}/contacts":{"post":{"tags":["Outbound"],"summary":"Add contacts to a contact list.","description":"","operationId":"postContactlistsContactlistIdContacts","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/Contact"}}},{"name":"priority","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Contact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postContactlistsContactlistIdContacts"}},"/api/v1/outbound/contactlists/{contactListId}/contacts/{contactId}":{"get":{"tags":["Outbound"],"summary":"Get dialer contactList.","description":"","operationId":"getContactlistsContactlistIdContactsContactId","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Contact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContactlistsContactlistIdContactsContactId"},"put":{"tags":["Outbound"],"summary":"Update a contact.","description":"","operationId":"putContactlistsContactlistIdContactsContactId","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact","required":false,"schema":{"$ref":"#/definitions/Contact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Contact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putContactlistsContactlistIdContactsContactId"},"delete":{"tags":["Outbound"],"summary":"Delete a contact.","description":"","operationId":"deleteContactlistsContactlistIdContactsContactId","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteContactlistsContactlistIdContactsContactId"}},"/api/v1/outbound/contactlists/{contactListId}/export":{"post":{"tags":["Outbound"],"summary":"Initiate the export of a contact list.","description":"Returns 200 if received OK.","operationId":"postContactlistsContactlistIdExport","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postContactlistsContactlistIdExport"}},"/api/v1/outbound/contactlists/{contactListId}/importstatus":{"get":{"tags":["Outbound"],"summary":"Get dialer contactList import status.","description":"","operationId":"getContactlistsContactlistIdImportstatus","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContactlistsContactlistIdImportstatus"}},"/api/v1/outbound/contactlists/{contactListId}/{campaignId}/penetrationrate":{"get":{"tags":["Outbound"],"summary":"Get Dialer campaign's penetration rate","description":"Get dialer campaign's penetration rate.","operationId":"getContactlistsContactlistIdCampaignIdPenetrationrate","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PenetrationRate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContactlistsContactlistIdCampaignIdPenetrationrate"}},"/api/v1/outbound/conversations/{conversationId}/dnc":{"post":{"tags":["Outbound"],"summary":"Add phone numbers to a Dialer DNC list.","description":"","operationId":"postConversationsConversationIdDnc","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationsConversationIdDnc"}},"/api/v1/outbound/dnclists":{"get":{"tags":["Outbound"],"summary":"Query dialer DNC lists","description":"","operationId":"getDnclists","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"importStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"PREFIX","enum":["EQUALS","REGEX","CONTAINS","PREFIX","LESSTHAN","LESSTHANEQUALTO","GREATERTHAN","GREATERTHANEQUALTO","BEGINSWITH","ENDSWITH"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncListEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDnclists"},"post":{"tags":["Outbound"],"summary":"Create dialer DNC list","description":"","operationId":"postDnclists","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"DncList","required":false,"schema":{"$ref":"#/definitions/DncList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDnclists"}},"/api/v1/outbound/dnclists/{dncListId}":{"get":{"tags":["Outbound"],"summary":"Get dialer DNC list","description":"","operationId":"getDnclistsDnclistId","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"importStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDnclistsDnclistId"},"put":{"tags":["Outbound"],"summary":"Update dialer DNC list","description":"","operationId":"putDnclistsDnclistId","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DncList","required":false,"schema":{"$ref":"#/definitions/DncList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putDnclistsDnclistId"},"delete":{"tags":["Outbound"],"summary":"Delete dialer DNC list","description":"","operationId":"deleteDnclistsDnclistId","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteDnclistsDnclistId"}},"/api/v1/outbound/dnclists/{dncListId}/export":{"post":{"tags":["Outbound"],"summary":"Initiate the export of a dnc list.","description":"Returns 200 if received OK.","operationId":"postDnclistsDnclistIdExport","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDnclistsDnclistIdExport"}},"/api/v1/outbound/dnclists/{dncListId}/importstatus":{"get":{"tags":["Outbound"],"summary":"Get dialer dncList import status.","description":"","operationId":"getDnclistsDnclistIdImportstatus","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDnclistsDnclistIdImportstatus"}},"/api/v1/outbound/dnclists/{dncListId}/phonenumbers":{"post":{"tags":["Outbound"],"summary":"Add phone numbers to a Dialer DNC list.","description":"","operationId":"postDnclistsDnclistIdPhonenumbers","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DNC Phone Numbers","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDnclistsDnclistIdPhonenumbers"}},"/api/v1/outbound/previews":{"get":{"tags":["Outbound"],"summary":"Get dialer preview for user","description":"","operationId":"getPreviews","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Preview"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPreviews"}},"/api/v1/outbound/previews/{previewId}":{"get":{"tags":["Outbound"],"summary":"Get dialer preview","description":"","operationId":"getPreviewsPreviewId","produces":["application/json"],"parameters":[{"name":"previewId","in":"path","description":"preview ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Preview"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPreviewsPreviewId"}},"/api/v1/outbound/previews/{previewId}/dispositioncall":{"post":{"tags":["Outbound"],"summary":"Disposition preview call","description":"","operationId":"postPreviewsPreviewIdDispositioncall","produces":["application/json"],"parameters":[{"name":"previewId","in":"path","description":"preview ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DialerDispositionCallCommand"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postPreviewsPreviewIdDispositioncall"}},"/api/v1/outbound/previews/{previewId}/placecall":{"post":{"tags":["Outbound"],"summary":"place preview call","description":"","operationId":"postPreviewsPreviewIdPlacecall","produces":["application/json"],"parameters":[{"name":"previewId","in":"path","description":"preview ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DialerPlaceCallCommand"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerCall"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postPreviewsPreviewIdPlacecall"}},"/api/v1/outbound/rulesets":{"get":{"tags":["Outbound"],"summary":"Query a list of Rule Sets.","description":"","operationId":"getRulesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"PREFIX","enum":["EQUALS","REGEX","CONTAINS","PREFIX","LESSTHAN","LESSTHANEQUALTO","GREATERTHAN","GREATERTHANEQUALTO","BEGINSWITH","ENDSWITH"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRulesets"},"post":{"tags":["Outbound"],"summary":"Create a Dialer Call Analysis Response Set.","description":"","operationId":"postRulesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"RuleSet","required":false,"schema":{"$ref":"#/definitions/RuleSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRulesets"}},"/api/v1/outbound/rulesets/{ruleSetId}":{"get":{"tags":["Outbound"],"summary":"Get a Rule Set by ID.","description":"","operationId":"getRulesetsRulesetId","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRulesetsRulesetId"},"put":{"tags":["Outbound"],"summary":"Update a RuleSet.","description":"","operationId":"putRulesetsRulesetId","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"RuleSet","required":false,"schema":{"$ref":"#/definitions/RuleSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRulesetsRulesetId"},"delete":{"tags":["Outbound"],"summary":"Delete a Rule set.","description":"","operationId":"deleteRulesetsRulesetId","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteRulesetsRulesetId"}},"/api/v1/outbound/schedules/campaigns":{"get":{"tags":["Outbound"],"summary":"Query for a list of dialer campaign schedules.","description":"","operationId":"getSchedulesCampaigns","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignSchedule"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchedulesCampaigns"}},"/api/v1/outbound/schedules/campaigns/{campaignId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer campaign schedule.","description":"","operationId":"getSchedulesCampaignsCampaignId","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchedulesCampaignsCampaignId"},"put":{"tags":["Outbound"],"summary":"Update a new campaign schedule.","description":"","operationId":"putSchedulesCampaignsCampaignId","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"CampaignSchedule","required":false,"schema":{"$ref":"#/definitions/CampaignSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSchedulesCampaignsCampaignId"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer campaign schedule.","description":"","operationId":"deleteSchedulesCampaignsCampaignId","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSchedulesCampaignsCampaignId"}},"/api/v1/outbound/schedules/sequences":{"get":{"tags":["Outbound"],"summary":"Query for a list of dialer sequence schedules.","description":"","operationId":"getSchedulesSequences","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/SequenceSchedule"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchedulesSequences"}},"/api/v1/outbound/schedules/sequences/{sequenceId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer sequence schedule.","description":"","operationId":"getSchedulesSequencesSequenceId","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SequenceSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchedulesSequencesSequenceId"},"put":{"tags":["Outbound"],"summary":"Update a new sequence schedule.","description":"","operationId":"putSchedulesSequencesSequenceId","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"SequenceSchedule","required":false,"schema":{"$ref":"#/definitions/SequenceSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SequenceSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSchedulesSequencesSequenceId"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer sequence schedule.","description":"","operationId":"deleteSchedulesSequencesSequenceId","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSchedulesSequencesSequenceId"}},"/api/v1/outbound/sequences":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer campaign sequences.","description":"","operationId":"getSequences","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"PREFIX","enum":["EQUALS","REGEX","CONTAINS","PREFIX","LESSTHAN","LESSTHANEQUALTO","GREATERTHAN","GREATERTHANEQUALTO","BEGINSWITH","ENDSWITH"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSequences"},"post":{"tags":["Outbound"],"summary":"Create a new campaign sequence.","description":"","operationId":"postSequences","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization","required":false,"schema":{"$ref":"#/definitions/CampaignSequence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSequences"}},"/api/v1/outbound/sequences/{sequenceId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer campaign sequence.","description":"","operationId":"getSequencesSequenceId","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSequencesSequenceId"},"put":{"tags":["Outbound"],"summary":"Update a new campaign sequence.","description":"","operationId":"putSequencesSequenceId","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization","required":false,"schema":{"$ref":"#/definitions/CampaignSequence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSequencesSequenceId"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer campaign sequence.","description":"","operationId":"deleteSequencesSequenceId","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSequencesSequenceId"}},"/api/v1/outbound/wrapupcodemappings":{"get":{"tags":["Outbound"],"summary":"Get the Dialer wrap up code mapping.","description":"","operationId":"getWrapupcodemappings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapUpCodeMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getWrapupcodemappings"},"put":{"tags":["Outbound"],"summary":"Update the Dialer wrap up code mapping.","description":"","operationId":"putWrapupcodemappings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"wrapUpCodeMapping","required":false,"schema":{"$ref":"#/definitions/WrapUpCodeMapping"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapUpCodeMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putWrapupcodemappings"}},"/api/v1/presencedefinitions":{"get":{"tags":["Presence"],"summary":"Get an Organization's list of Presences","description":"","operationId":"getPresencedefinitions","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPresencedefinitions"},"post":{"tags":["Presence"],"summary":"Create an OrganizationPresence","description":"","operationId":"postPresencedefinitions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The OrganizationPresence to create","required":true,"schema":{"$ref":"#/definitions/OrganizationPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postPresencedefinitions"}},"/api/v1/presencedefinitions/{presenceId}":{"get":{"tags":["Presence"],"summary":"Get an OrganizationPresence","description":"","operationId":"getPresenceId","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPresenceId"},"put":{"tags":["Presence"],"summary":"Update an OrganizationPresence","description":"","operationId":"putPresenceId","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The OrganizationPresence to update","required":true,"schema":{"$ref":"#/definitions/OrganizationPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putPresenceId"},"delete":{"tags":["Presence"],"summary":"Delete an OrganizationPresence","description":"","operationId":"deletePresenceId","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deletePresenceId"}},"/api/v1/quality/agents/activity":{"get":{"tags":["Quality"],"summary":"Gets a list of Agent Activities","description":"Including the number of evaluations and average evaluation score","operationId":"getAgentsActivity","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"startTime","in":"query","description":"Start time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"End time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required":false,"type":"string","format":"date-time"},{"name":"agentUserId","in":"query","description":"user id of agent requested","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"evaluatorUserId","in":"query","description":"user id of the evaluator","required":false,"type":"string"},{"name":"name","in":"query","description":"name","required":false,"type":"string"},{"name":"group","in":"query","description":"group id","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentActivityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getAgentsActivity"}},"/api/v1/quality/calibrations":{"get":{"tags":["Quality"],"summary":"Get the list of calibrations","description":"","operationId":"getCalibrations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"conversationId","in":"query","description":"conversation id","required":false,"type":"string"},{"name":"startTime","in":"query","description":"Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required":false,"type":"string","format":"date-time"},{"name":"calibratorId","in":"query","description":"user id of calibrator","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CalibrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCalibrations"},"post":{"tags":["Quality"],"summary":"Create a calibration","description":"","operationId":"postCalibrations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"calibration","required":false,"schema":{"$ref":"#/definitions/Calibration"}},{"name":"expand","in":"query","description":"calibratorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCalibrations"}},"/api/v1/quality/calibrations/{calibrationId}":{"get":{"tags":["Quality"],"summary":"Get a calibration by id.","description":"","operationId":"getCalibrationsCalibrationId","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"name":"calibratorId","in":"query","description":"calibratorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCalibrationsCalibrationId"},"put":{"tags":["Quality"],"summary":"Update a calibration to the specified calibration via PUT.  Editable fields include: evaluators, expertEvaluator, and scoringIndex","description":"","operationId":"putCalibrationsCalibrationId","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Calibration","required":false,"schema":{"$ref":"#/definitions/Calibration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putCalibrationsCalibrationId"},"delete":{"tags":["Quality"],"summary":"Delete a calibration by id.","description":"","operationId":"deleteCalibrationsCalibrationId","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"name":"calibratorId","in":"query","description":"calibratorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCalibrationsCalibrationId"}},"/api/v1/quality/conversations/{conversationId}/audits":{"get":{"tags":["Quality"],"summary":"Get audits for conversation or recording","description":"","operationId":"getConversationsConversationIdAudits","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"recordingId","in":"query","description":"id of the recording","required":false,"type":"string"},{"name":"entityType","in":"query","description":"entity type options: Recording, Calibration, Evaluation, Annotation","required":false,"type":"string","default":"RECORDING"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QualityAuditPage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationsConversationIdAudits"}},"/api/v1/quality/conversations/{conversationId}/evaluations":{"post":{"tags":["Quality"],"summary":"Create an evaluation","description":"","operationId":"postConversationsConversationIdEvaluations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","description":"evaluation","required":false,"schema":{"$ref":"#/definitions/Evaluation"}},{"name":"expand","in":"query","description":"evaluatorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Evaluation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationsConversationIdEvaluations"}},"/api/v1/quality/conversations/{conversationId}/evaluations/{evaluationId}":{"get":{"tags":["Quality"],"summary":"Get an evaluation","description":"","operationId":"getConversationsConversationIdEvaluationsEvaluationId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","required":true,"type":"string"},{"name":"evaluationId","in":"path","required":true,"type":"string"},{"name":"expand","in":"query","description":"agent, evaluator, evaluationForm","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Evaluation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationsConversationIdEvaluationsEvaluationId"},"put":{"tags":["Quality"],"summary":"Update an evaluation","description":"","operationId":"putConversationsConversationIdEvaluationsEvaluationId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","required":true,"type":"string"},{"name":"evaluationId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","description":"evaluation","required":false,"schema":{"$ref":"#/definitions/Evaluation"}},{"name":"expand","in":"query","description":"evaluatorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Evaluation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putConversationsConversationIdEvaluationsEvaluationId"},"delete":{"tags":["Quality"],"summary":"Delete an evaluation","description":"","operationId":"deleteConversationsConversationIdEvaluationsEvaluationId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","required":true,"type":"string"},{"name":"evaluationId","in":"path","required":true,"type":"string"},{"name":"expand","in":"query","description":"evaluatorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Evaluation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteConversationsConversationIdEvaluationsEvaluationId"}},"/api/v1/quality/evaluations/query":{"get":{"tags":["Quality"],"summary":"Queries Evaluations and returns a paged list","description":"Query params must include one of conversationId, evaluatorUserId, or agentUserId","operationId":"getEvaluationsQuery","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"conversationId","in":"query","description":"conversationId specified","required":false,"type":"string"},{"name":"agentUserId","in":"query","description":"user id of the agent","required":false,"type":"string"},{"name":"evaluatorUserId","in":"query","description":"evaluator user id","required":false,"type":"string"},{"name":"queueId","in":"query","description":"queue id","required":false,"type":"string"},{"name":"startTime","in":"query","description":"start time of the evaluation query","required":false,"type":"string"},{"name":"endTime","in":"query","description":"end time of the evaluation query","required":false,"type":"string"},{"name":"evaluationState","in":"query","description":"evaluation state options: Pending, InProgress, Finished","required":false,"type":"array","items":{"type":"string","enum":["PENDING","INPROGRESS","FINISHED"]},"collectionFormat":"multi"},{"name":"isReleased","in":"query","description":"the evaluation has been released","required":false,"type":"boolean"},{"name":"agentHasRead","in":"query","description":"agent has the evaluation","required":false,"type":"boolean"},{"name":"expandAnswerTotalScores","in":"query","description":"get the total scores for evaluations","required":false,"type":"boolean"},{"name":"maximum","in":"query","description":"maximum","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEvaluationsQuery"},"post":{"tags":["Quality"],"summary":"Query evaluations","description":"","operationId":"postEvaluationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":false,"schema":{"$ref":"#/definitions/EvaluationQueryRequest"}},{"name":"expand","in":"query","description":"evaluator,agent","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEvaluationsQuery"}},"/api/v1/quality/evaluations/scoring":{"post":{"tags":["Quality"],"summary":"Score evaluation","description":"","operationId":"postEvaluationsScoring","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"evaluationAndScoringSet","required":false,"schema":{"$ref":"#/definitions/EvaluationFormAndScoringSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationScoringSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEvaluationsScoring"}},"/api/v1/quality/evaluators/activity":{"get":{"tags":["Quality"],"summary":"Get an evaluator activity","description":"","operationId":"getEvaluatorsActivity","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"startTime","in":"query","description":"The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required":false,"type":"string","format":"date-time"},{"name":"name","in":"query","description":"Evaluator name","required":false,"type":"string"},{"name":"permission","in":"query","description":"permission strings","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"group","in":"query","description":"group id","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluatorActivityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEvaluatorsActivity"}},"/api/v1/quality/forms":{"get":{"tags":["Scripts"],"summary":"Get the list of evaluation forms","description":"","operationId":"getForms","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getForms"},"post":{"tags":["Scripts"],"summary":"Create an evaluation form.","description":"","operationId":"postForms","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postForms"}},"/api/v1/quality/forms/{formId}":{"get":{"tags":["Scripts"],"summary":"Get an evaluation form","description":"","operationId":"getFormsFormId","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFormsFormId"},"put":{"tags":["Scripts"],"summary":"Update an evaluation form.","description":"","operationId":"putFormsFormId","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putFormsFormId"},"delete":{"tags":["Scripts"],"summary":"Delete an evaluation form.","description":"","operationId":"deleteFormsFormId","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteFormsFormId"}},"/api/v1/quality/forms/{formId}/versions":{"get":{"tags":["Scripts"],"summary":"Gets all the revisions for a specific evaluation.","description":"","operationId":"getFormsFormIdVersions","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFormsFormIdVersions"}},"/api/v1/quality/publishedforms":{"get":{"tags":["Scripts"],"summary":"Get the published evaluation forms.","description":"","operationId":"getPublishedforms","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPublishedforms"},"post":{"tags":["Scripts"],"summary":"Publish an evaluation form.","description":"","operationId":"postPublishedforms","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postPublishedforms"}},"/api/v1/quality/publishedforms/{formId}":{"get":{"tags":["Scripts"],"summary":"Get the published evaluation forms.","description":"","operationId":"getPublishedformsFormId","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPublishedformsFormId"}},"/api/v1/recording/mediaretentionpolicies":{"get":{"tags":["Recording"],"summary":"Gets media retention policy list with query options to filter on name and enabled.","description":"for a less verbose response, add summary=true to this endpoint","operationId":"getMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"the policy name - used for filtering results in searches.","required":false,"type":"string"},{"name":"enabled","in":"query","description":"checks to see if policy is enabled - use enabled = true or enabled = false","required":false,"type":"boolean"},{"name":"summary","in":"query","description":"provides a less verbose response of policy lists.","required":false,"type":"boolean","default":false},{"name":"hasErrors","in":"query","description":"provides a way to fetch all policies with errors or policies that do not have errors","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PolicyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMediaretentionpolicies"},"post":{"tags":["Recording"],"summary":"Create media retention policy","description":"","operationId":"postMediaretentionpolicies","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Policy","required":false,"schema":{"$ref":"#/definitions/Policy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postMediaretentionpolicies"},"delete":{"tags":["Recording"],"summary":"Delete media retention policies","description":"Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.","operationId":"deleteMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"ids","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteMediaretentionpolicies"}},"/api/v1/recording/mediaretentionpolicies/{policyId}":{"get":{"tags":["Recording"],"summary":"Get a media retention policy","description":"","operationId":"getMediaretentionpoliciesPolicyId","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMediaretentionpoliciesPolicyId"},"put":{"tags":["Recording"],"summary":"Update a media retention policy","description":"","operationId":"putMediaretentionpoliciesPolicyId","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":false,"schema":{"$ref":"#/definitions/Policy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putMediaretentionpoliciesPolicyId"},"delete":{"tags":["Recording"],"summary":"Delete a media retention policy","description":"","operationId":"deleteMediaretentionpoliciesPolicyId","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteMediaretentionpoliciesPolicyId"},"patch":{"tags":["Recording"],"summary":"Patch a media retention policy","description":"","operationId":"patchMediaretentionpoliciesPolicyId","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":false,"schema":{"$ref":"#/definitions/Policy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchMediaretentionpoliciesPolicyId"}},"/api/v1/recording/settings":{"get":{"tags":["Recording"],"summary":"Get the Recording Settings for the Organization","description":"","operationId":"getSettings","produces":["application/json"],"parameters":[{"name":"createDefault","in":"query","description":"If no settings are found, a new one is created with default values","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSettings"},"put":{"tags":["Recording"],"summary":"Update the Recording Settings for the Organization","description":"","operationId":"putSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/RecordingSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSettings"}},"/api/v1/responsemanagement/libraries":{"get":{"tags":["Response Management"],"summary":"Gets a list of existing response libraries.","description":"","operationId":"getLibraries","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LibraryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLibraries"},"post":{"tags":["Response Management"],"summary":"Create a response library.","description":"","operationId":"postLibraries","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Library","required":false,"schema":{"$ref":"#/definitions/Library"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postLibraries"}},"/api/v1/responsemanagement/libraries/{libraryId}":{"get":{"tags":["Response Management"],"summary":"Get details about an existing response library.","description":"","operationId":"getLibrariesLibraryId","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLibrariesLibraryId"},"put":{"tags":["Response Management"],"summary":"Update an existing response library.","description":"Fields that can be updated: name. The most recent version is required for updates.","operationId":"putLibrariesLibraryId","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Library","required":false,"schema":{"$ref":"#/definitions/Library"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"409":{"description":"Resource conflict - Unexpected version was provided"},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putLibrariesLibraryId"},"delete":{"tags":["Response Management"],"summary":"Delete an existing response library.","description":"This will remove any responses associated with the library.","operationId":"deleteLibrariesLibraryId","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteLibrariesLibraryId"}},"/api/v1/responsemanagement/responses":{"get":{"tags":["Response Management"],"summary":"Gets a list of existing responses.","description":"","operationId":"getResponses","produces":["application/json"],"parameters":[{"name":"libraryId","in":"query","description":"Library ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getResponses"},"post":{"tags":["Response Management"],"summary":"Create a response.","description":"","operationId":"postResponses","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Response","required":false,"schema":{"$ref":"#/definitions/Response"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postResponses"}},"/api/v1/responsemanagement/responses/query":{"post":{"tags":["Response Management"],"summary":"Query responses","description":"","operationId":"postResponsesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Response","required":false,"schema":{"$ref":"#/definitions/ResponseQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseQueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postResponsesQuery"}},"/api/v1/responsemanagement/responses/{responseId}":{"get":{"tags":["Response Management"],"summary":"Get details about an existing response.","description":"","operationId":"getResponsesResponseId","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getResponsesResponseId"},"put":{"tags":["Response Management"],"summary":"Update an existing response.","description":"Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.","operationId":"putResponsesResponseId","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Response","required":false,"schema":{"$ref":"#/definitions/Response"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"409":{"description":"Resource conflict - Unexpected version was provided"},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putResponsesResponseId"},"delete":{"tags":["Response Management"],"summary":"Delete an existing response.","description":"This will remove the response from any libraries associated with it.","operationId":"deleteResponsesResponseId","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteResponsesResponseId"}},"/api/v1/routing/email/domains":{"get":{"tags":["Routing"],"summary":"Get domains","description":"","operationId":"getEmailDomains","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailDomains"},"post":{"tags":["Routing"],"summary":"Create a domain","description":"","operationId":"postEmailDomains","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Domain","required":false,"schema":{"$ref":"#/definitions/InboundDomain"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEmailDomains"}},"/api/v1/routing/email/domains/{domain}/routes":{"get":{"tags":["Routing"],"summary":"Get routes","description":"","operationId":"getEmailDomainsDomainRoutes","produces":["application/json"],"parameters":[{"name":"domain","in":"path","description":"email domain","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRouteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailDomainsDomainRoutes"},"post":{"tags":["Routing"],"summary":"Create a route","description":"","operationId":"postEmailDomainsDomainRoutes","produces":["application/json"],"parameters":[{"name":"domain","in":"path","description":"email domain","required":true,"type":"string"},{"in":"body","name":"body","description":"Route","required":false,"schema":{"$ref":"#/definitions/InboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEmailDomainsDomainRoutes"}},"/api/v1/routing/email/domains/{domain}/routes/{id}":{"get":{"tags":["Routing"],"summary":"Get a route","description":"","operationId":"getEmailDomainsDomainRoutesId","produces":["application/json"],"parameters":[{"name":"domain","in":"path","description":"email domain","required":true,"type":"string"},{"name":"id","in":"path","description":"route ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailDomainsDomainRoutesId"},"put":{"tags":["Routing"],"summary":"Update a route","description":"","operationId":"putEmailDomainsDomainRoutesId","produces":["application/json"],"parameters":[{"name":"domain","in":"path","description":"email domain","required":true,"type":"string"},{"name":"id","in":"path","description":"route ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Route","required":false,"schema":{"$ref":"#/definitions/InboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putEmailDomainsDomainRoutesId"},"delete":{"tags":["Routing"],"summary":"Delete a route","description":"","operationId":"deleteEmailDomainsDomainRoutesId","produces":["application/json"],"parameters":[{"name":"domain","in":"path","description":"email domain","required":true,"type":"string"},{"name":"id","in":"path","description":"route ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteEmailDomainsDomainRoutesId"}},"/api/v1/routing/email/domains/{id}":{"delete":{"tags":["Routing"],"summary":"Delete a domain","description":"","operationId":"deleteEmailDomainsId","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteEmailDomainsId"}},"/api/v1/routing/email/setup":{"get":{"tags":["Routing"],"summary":"Get email setup","description":"","operationId":"getEmailSetup","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailSetup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailSetup"}},"/api/v1/routing/queues":{"get":{"tags":["Routing"],"summary":"Get list of queues.","description":"","operationId":"getQueues","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"active","in":"query","description":"Active","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getQueues"},"post":{"tags":["Routing"],"summary":"Create queue","description":"","operationId":"postQueues","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Queue","required":false,"schema":{"$ref":"#/definitions/Queue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQueues"}},"/api/v1/routing/queues/{queueId}":{"get":{"tags":["Routing"],"summary":"Get details about this queue.","description":"","operationId":"getQueuesQueueId","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getQueuesQueueId"},"put":{"tags":["Routing"],"summary":"Update a queue","description":"","operationId":"putQueuesQueueId","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue","required":false,"schema":{"$ref":"#/definitions/Queue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putQueuesQueueId"},"delete":{"tags":["Routing"],"summary":"Delete a queue","description":"","operationId":"deleteQueuesQueueId","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"forceDelete","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteQueuesQueueId"}},"/api/v1/routing/queues/{queueId}/estimatedwaittime":{"get":{"tags":["Routing"],"summary":"Get Estimated Wait Time","description":"","operationId":"getQueuesQueueIdEstimatedwaittime","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"queueId","required":true,"type":"string"},{"name":"conversationId","in":"query","description":"conversationId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EstimatedWaitTimePredictions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getQueuesQueueIdEstimatedwaittime"}},"/api/v1/routing/queues/{queueId}/members":{"get":{"tags":["Routing"],"summary":"Get members in a queue","description":"Get the list of members of a queue","operationId":"getQueuesQueueIdMembers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"userId","in":"query","description":"UserID","required":false,"type":"string"},{"name":"statusId","in":"query","description":"Status ID","required":false,"type":"string"},{"name":"joined","in":"query","description":"Joined","required":false,"type":"boolean"},{"name":"expand","in":"query","description":"expand","required":false,"type":"string","enum":["routingStatus"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getQueuesQueueIdMembers"}},"/api/v1/routing/queues/{queueId}/members/{memberId}":{"put":{"tags":["Routing"],"summary":"Join or unjoin a user to the queue.","description":"","operationId":"putQueuesQueueIdMembersMemberId","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member/User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"To join queue ~ \"joined\":true","required":false,"schema":{"$ref":"#/definitions/QueueMember"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putQueuesQueueIdMembersMemberId"}},"/api/v1/routing/queues/{queueId}/users":{"get":{"tags":["Routing"],"summary":"Get the members of this queue","description":"","operationId":"getQueuesQueueIdUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"expand","in":"query","description":"expand","required":false,"type":"string"},{"name":"directMembers","in":"query","description":"Only get users that are direct members of the queue","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getQueuesQueueIdUsers"},"post":{"tags":["Routing"],"summary":"Bulk add or delete up to 100 queue members","description":"","operationId":"postQueuesQueueIdUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}}},{"name":"delete","in":"query","description":"True to delete queue members","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQueuesQueueIdUsers"},"patch":{"tags":["Routing"],"summary":"Join or unjoin a set of users for a queue","description":"","operationId":"patchQueuesQueueIdUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchQueuesQueueIdUsers"}},"/api/v1/routing/queues/{queueId}/users/{memberId}":{"delete":{"tags":["Routing"],"summary":"Delete queue member","description":"","operationId":"deleteQueuesQueueIdUsersMemberId","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteQueuesQueueIdUsersMemberId"},"patch":{"tags":["Routing"],"summary":"Update the ring number of joined status for a User in a Queue","description":"","operationId":"patchQueuesQueueIdUsersMemberId","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Member","required":false,"schema":{"$ref":"#/definitions/QueueMember"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMember"}},"202":{"description":"User ring number change has been accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchQueuesQueueIdUsersMemberId"}},"/api/v1/routing/queues/{queueId}/wrapupcodes":{"get":{"tags":["Routing"],"summary":"Get the wrap-up codes for a queue","description":"","operationId":"getQueuesQueueIdWrapupcodes","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"codeId","in":"path","description":"Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getQueuesQueueIdWrapupcodes"},"post":{"tags":["Routing"],"summary":"Add up to 100 wrap-up codes to a queue","description":"","operationId":"postQueuesQueueIdWrapupcodes","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"codeId","in":"path","description":"Code ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQueuesQueueIdWrapupcodes"}},"/api/v1/routing/queues/{queueId}/wrapupcodes/{codeId}":{"delete":{"tags":["Routing"],"summary":"Delete a wrap-up code from a queue","description":"","operationId":"deleteQueuesQueueIdWrapupcodesCodeId","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"codeId","in":"path","description":"Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteQueuesQueueIdWrapupcodesCodeId"}},"/api/v1/routing/skills":{"get":{"tags":["Routing"],"summary":"Get the list of skills.","description":"","operationId":"getSkills","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSkills"}},"/api/v1/routing/utilization":{"get":{"tags":["Routing"],"summary":"Get the utilization settings.","description":"","operationId":"getUtilization","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Utilization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUtilization"},"put":{"tags":["Routing"],"summary":"Update the utilization settings.","description":"","operationId":"putUtilization","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"utilization","required":false,"schema":{"$ref":"#/definitions/Utilization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Utilization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUtilization"},"delete":{"tags":["Routing"],"summary":"Delete utilization settings and revert to system defaults.","description":"","operationId":"deleteUtilization","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteUtilization"}},"/api/v1/routing/wrapupcodes":{"get":{"tags":["Routing"],"summary":"Get list of wrapup codes.","description":"","operationId":"getWrapupcodes","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCodeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getWrapupcodes"},"post":{"tags":["Routing"],"summary":"Create a wrap-up code","description":"","operationId":"postWrapupcodes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"WrapupCode","required":false,"schema":{"$ref":"#/definitions/WrapupCode"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postWrapupcodes"}},"/api/v1/routing/wrapupcodes/{codeId}":{"get":{"tags":["Routing"],"summary":"Get details about this wrap-up code.","description":"","operationId":"getWrapupcodesCodeId","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getWrapupcodesCodeId"},"put":{"tags":["Routing"],"summary":"Update wrap-up code","description":"","operationId":"putWrapupcodesCodeId","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"},{"in":"body","name":"body","description":"WrapupCode","required":false,"schema":{"$ref":"#/definitions/WrapupCode"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putWrapupcodesCodeId"},"delete":{"tags":["Routing"],"summary":"Delete wrap-up code","description":"","operationId":"deleteWrapupcodesCodeId","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteWrapupcodesCodeId"}},"/api/v1/scripts":{"get":{"tags":["Scripts"],"summary":"Get the list of scripts","description":"","operationId":"getScripts","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"feature","in":"query","description":"Feature","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScriptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getScripts"},"post":{"tags":["Scripts"],"summary":"Create a script.","description":"","operationId":"postScripts","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Script"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postScripts"}},"/api/v1/search/chats":{"post":{"tags":["Search"],"summary":"Search chat history","description":"","operationId":"postChats","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":false,"schema":{"$ref":"#/definitions/ChatSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSearchListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postChats"}},"/api/v1/stations":{"get":{"tags":["Stations"],"summary":"Get the list of available stations.","description":"","operationId":"getStations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getStations"}},"/api/v1/stations/{id}":{"get":{"tags":["Stations"],"summary":"Get station.","description":"","operationId":"getId","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Station ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Station"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getId"}},"/api/v1/stations/{id}/associateduser":{"delete":{"tags":["Stations"],"summary":"Unassigns the user assigned to this station","description":"","operationId":"deleteIdAssociateduser","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Station ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteIdAssociateduser"}},"/api/v1/telephony/providers/edge/edgegroups":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of edge groups.","description":"","operationId":"getProvidersEdgeEdgegroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeEdgegroups"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge group.","description":"","operationId":"postProvidersEdgeEdgegroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"EdgeGroup","required":false,"schema":{"$ref":"#/definitions/EdgeGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgeEdgegroups"}},"/api/v1/telephony/providers/edge/edgegroups/{edgeGroupId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge group.","description":"","operationId":"getProvidersEdgeEdgegroupsEdgegroupId","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeEdgegroupsEdgegroupId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an edge group.","description":"","operationId":"putProvidersEdgeEdgegroupsEdgegroupId","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EdgeGroup","required":false,"schema":{"$ref":"#/definitions/EdgeGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgeEdgegroupsEdgegroupId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an edge group.","description":"","operationId":"deleteProvidersEdgeEdgegroupsEdgegroupId","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgeEdgegroupsEdgegroupId"}},"/api/v1/telephony/providers/edge/linebasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of line base settings objects","description":"","operationId":"getProvidersEdgeLinebasesettings","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeLinebasesettings"}},"/api/v1/telephony/providers/edge/linebasesettings/{lineBaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a line base settings object by ID","description":"","operationId":"getProvidersEdgeLinebasesettingsLinebaseId","produces":["application/json"],"parameters":[{"name":"lineBaseId","in":"path","description":"Line base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeLinebasesettingsLinebaseId"}},"/api/v1/telephony/providers/edge/lines":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Lines","description":"","operationId":"getProvidersEdgeLines","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties","site","edgeGroup","primaryEdge","secondaryEdge","edges","assignedUser"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeLines"}},"/api/v1/telephony/providers/edge/lines/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance","description":"","operationId":"getProvidersEdgeLinesTemplate","produces":["application/json"],"parameters":[{"name":"lineBaseSettingsId","in":"query","description":"The id of a Line Base Settings object upon which to base this Line","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Line"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeLinesTemplate"}},"/api/v1/telephony/providers/edge/lines/{lineId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Line by ID","description":"","operationId":"getProvidersEdgeLinesLineId","produces":["application/json"],"parameters":[{"name":"lineId","in":"path","description":"Line ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Line"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeLinesLineId"}},"/api/v1/telephony/providers/edge/outboundroutes":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get outbound routes","description":"","operationId":"getProvidersEdgeOutboundroutes","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"site.id","in":"query","description":"Filter by site.id","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeOutboundroutes"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create outbound rule","description":"","operationId":"postProvidersEdgeOutboundroutes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"OutboundRoute","required":false,"schema":{"$ref":"#/definitions/OutboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgeOutboundroutes"}},"/api/v1/telephony/providers/edge/outboundroutes/{outboundRouteId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get outbound route","description":"","operationId":"getProvidersEdgeOutboundroutesOutboundrouteId","produces":["application/json"],"parameters":[{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeOutboundroutesOutboundrouteId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update outbound route","description":"","operationId":"putProvidersEdgeOutboundroutesOutboundrouteId","produces":["application/json"],"parameters":[{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"},{"in":"body","name":"body","description":"OutboundRoute","required":false,"schema":{"$ref":"#/definitions/OutboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgeOutboundroutesOutboundrouteId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete Outbound Route","description":"","operationId":"deleteProvidersEdgeOutboundroutesOutboundrouteId","produces":["application/json"],"parameters":[{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgeOutboundroutesOutboundrouteId"}},"/api/v1/telephony/providers/edge/phonebasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Phone Base Settings objects","description":"","operationId":"getProvidersEdgePhonebasesettings","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgePhonebasesettings"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new Phone Base Settings object","description":"","operationId":"postProvidersEdgePhonebasesettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PhoneBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgePhonebasesettings"}},"/api/v1/telephony/providers/edge/phonebasesettings/availablemetabases":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of available makes and models to create a new Phone Base Settings","description":"","operationId":"getProvidersEdgePhonebasesettingsAvailablemetabases","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneMetaBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgePhonebasesettingsAvailablemetabases"}},"/api/v1/telephony/providers/edge/phonebasesettings/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance","description":"","operationId":"getProvidersEdgePhonebasesettingsTemplate","produces":["application/json"],"parameters":[{"name":"phoneMetabaseId","in":"query","description":"The id of a metabase object upon which to base this Phone Base Settings","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgePhonebasesettingsTemplate"}},"/api/v1/telephony/providers/edge/phonebasesettings/{phoneBaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone Base Settings object by ID","description":"","operationId":"getProvidersEdgePhonebasesettingsPhonebaseId","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgePhonebasesettingsPhonebaseId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Phone Base Settings by ID","description":"","operationId":"putProvidersEdgePhonebasesettingsPhonebaseId","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PhoneBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgePhonebasesettingsPhonebaseId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Phone Base Settings by ID","description":"","operationId":"deleteProvidersEdgePhonebasesettingsPhonebaseId","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgePhonebasesettingsPhonebaseId"}},"/api/v1/telephony/providers/edge/phones":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Phone Instances","description":"","operationId":"getProvidersEdgePhones","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"site.id","in":"query","description":"Filter by site.id","required":false,"type":"string"},{"name":"phoneBaseSettings.id","in":"query","description":"Filter by phoneBaseSettings.id","required":false,"type":"string"},{"name":"phone_hardwareId","in":"query","description":"Filter by phone_hardwareId","required":false,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties","site","edgeGroup","status","status.primaryEdgesStatus","status.secondaryEdgesStatus","phoneBaseSettings","lines"]},"collectionFormat":"multi"},{"name":"fields","in":"query","description":"Fields under properties to get, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties.*"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgePhones"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new Phone","description":"","operationId":"postProvidersEdgePhones","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Phone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgePhones"}},"/api/v1/telephony/providers/edge/phones/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot Multiple Phones","description":"","operationId":"postProvidersEdgePhonesReboot","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/PhonesReboot"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgePhonesReboot"}},"/api/v1/telephony/providers/edge/phones/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance","description":"","operationId":"getProvidersEdgePhonesTemplate","produces":["application/json"],"parameters":[{"name":"phoneBaseSettingsId","in":"query","description":"The id of a Phone Base Settings object upon which to base this Phone","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgePhonesTemplate"}},"/api/v1/telephony/providers/edge/phones/{phoneId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone by ID","description":"","operationId":"getProvidersEdgePhonesPhoneId","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgePhonesPhoneId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Phone by ID","description":"","operationId":"putProvidersEdgePhonesPhoneId","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Phone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgePhonesPhoneId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Phone by ID","description":"","operationId":"deleteProvidersEdgePhonesPhoneId","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgePhonesPhoneId"}},"/api/v1/telephony/providers/edge/phones/{phoneId}/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot a Phone","description":"","operationId":"postProvidersEdgePhonesPhoneIdReboot","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone Id","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgePhonesPhoneIdReboot"}},"/api/v1/telephony/providers/edge/timezones":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Edge-compatible time zones","description":"","operationId":"getProvidersEdgeTimezones","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":1000,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeZoneEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeTimezones"}},"/api/v1/telephony/providers/edge/trunkbasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get Trunk Base Settings listing","description":"","operationId":"getProvidersEdgeTrunkbasesettings","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeTrunkbasesettings"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a Trunk Base Settings object","description":"","operationId":"postProvidersEdgeTrunkbasesettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TrunkBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgeTrunkbasesettings"}},"/api/v1/telephony/providers/edge/trunkbasesettings/availablemetabases":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of available makes and models to create a new Trunk Base Settings","description":"","operationId":"getProvidersEdgeTrunkbasesettingsAvailablemetabases","produces":["application/json"],"parameters":[{"name":"type","in":"query","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"]},{"name":"pageSize","in":"query","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkMetabaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeTrunkbasesettingsAvailablemetabases"}},"/api/v1/telephony/providers/edge/trunkbasesettings/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance","description":"","operationId":"getProvidersEdgeTrunkbasesettingsTemplate","produces":["application/json"],"parameters":[{"name":"trunkMetabaseId","in":"query","description":"The id of a metabase object upon which to base this Trunk Base Settings","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeTrunkbasesettingsTemplate"}},"/api/v1/telephony/providers/edge/trunkbasesettings/{trunkBaseSettingsId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk Base Settings object by ID","description":"","operationId":"getProvidersEdgeTrunkbasesettingsTrunkbasesettingsId","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgeTrunkbasesettingsTrunkbasesettingsId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Trunk Base Settings object by ID","description":"","operationId":"putProvidersEdgeTrunkbasesettingsTrunkbasesettingsId","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TrunkBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgeTrunkbasesettingsTrunkbasesettingsId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Trunk Base Settings object by ID","description":"","operationId":"deleteProvidersEdgeTrunkbasesettingsTrunkbasesettingsId","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgeTrunkbasesettingsTrunkbasesettingsId"}},"/api/v1/timezones":{"get":{"tags":["Utilities"],"summary":"Get time zones list","description":"","operationId":"getTimezones","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeZoneEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getTimezones"}},"/api/v1/tokens/me":{"delete":{"tags":["Tokens"],"summary":"Delete  auth token used to make the request.","description":"","operationId":"deleteMe","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteMe"}},"/api/v1/userrecordings":{"get":{"tags":["User Recordings"],"summary":"Get a list of user recordings.","description":"","operationId":"getUserrecordings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"conversation","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRecordingEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserrecordings"}},"/api/v1/userrecordings/summary":{"get":{"tags":["User Recordings"],"summary":"Get user recording summary","description":"","operationId":"getSummary","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxSummary"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSummary"}},"/api/v1/userrecordings/{recordingId}":{"get":{"tags":["User Recordings"],"summary":"Get a user recording.","description":"","operationId":"getRecordingId","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"conversation","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRecordingId"},"put":{"tags":["User Recordings"],"summary":"Update a user recording.","description":"","operationId":"putRecordingId","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"},{"in":"body","name":"body","description":"UserRecording","required":false,"schema":{"$ref":"#/definitions/UserRecording"}},{"name":"expand","in":"query","description":"conversation","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRecordingId"},"delete":{"tags":["User Recordings"],"summary":"Delete a user recording.","description":"","operationId":"deleteRecordingId","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteRecordingId"}},"/api/v1/userrecordings/{recordingId}/media":{"get":{"tags":["User Recordings"],"summary":"Download a user recording.","description":"","operationId":"getRecordingIdMedia","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired format (WEBM, WAV, etc.)","required":false,"type":"string","default":"WEBM","enum":["WEBM","WAV"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DownloadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRecordingIdMedia"}},"/api/v1/users":{"get":{"tags":["Users"],"summary":"Get the list of available users.","description":"","operationId":"getUsers","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"role","in":"query","description":"Role","required":false,"type":"string"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"username","in":"query","description":"Username","required":false,"type":"string"},{"name":"skill","in":"query","description":"Skill","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["[routingStatus","primaryPresence","conversationSummary","outOfOffice","geolocation]"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUsers"},"post":{"tags":["Users"],"summary":"Create a configuration service user.","description":"","operationId":"postUsers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"User","required":false,"schema":{"$ref":"#/definitions/User"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postUsers"}},"/api/v1/users/me":{"get":{"tags":["Users"],"summary":"Get user.","description":"","operationId":"getMe","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["[routingStatus","primaryPresence","conversationSummary","geolocation]"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMe"}},"/api/v1/users/{userId}":{"get":{"tags":["Users"],"summary":"Get user.","description":"","operationId":"getUserId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["[routingStatus","primaryPresence","conversationSummary","outOfOffice","geolocation]"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserId"},"put":{"tags":["Users"],"summary":"Set user station","description":"","operationId":"putUserId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"stationUri","required":true,"schema":{"$ref":"#/definitions/User"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserId"}},"/api/v1/users/{userId}/callforwarding":{"get":{"tags":["Users"],"summary":"Get a user's CallForwarding","description":"","operationId":"getUserIdCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdCallforwarding"},"put":{"tags":["Users"],"summary":"Update a user's CallForwarding","description":"","operationId":"putUserIdCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CallForwarding"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdCallforwarding"},"patch":{"tags":["Users"],"summary":"Patch a user's CallForwarding","description":"","operationId":"patchUserIdCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CallForwarding"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserIdCallforwarding"}},"/api/v1/users/{userId}/geolocations/{clientId}":{"get":{"tags":["Geolocation","Users"],"summary":"Get a user's Geolocation","description":"","operationId":"getUserIdGeolocationsClientId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"clientId","in":"path","description":"client Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Geolocation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdGeolocationsClientId"},"patch":{"tags":["Geolocation","Users"],"summary":"Patch a user's Geolocation","description":"The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source.  Option 2: Provide the 'latitude' and 'longitude' values.  This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'.  Option 3:  Provide the 'city', 'region', 'country' values.  Option 1 can be combined with Option 2 or Option 3.  For example, update the client as primary and provide latitude and longitude values.","operationId":"patchUserIdGeolocationsClientId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"clientId","in":"path","description":"client Id","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Geolocation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Geolocation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserIdGeolocationsClientId"}},"/api/v1/users/{userId}/greetings":{"get":{"tags":["Greetings"],"summary":"Get a list of the User's Greetings","description":"","operationId":"getUserIdGreetings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdGreetings"},"post":{"tags":["Greetings"],"summary":"Creates a Greeting for a User","description":"","operationId":"postUserIdGreetings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The Greeting to create","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postUserIdGreetings"}},"/api/v1/users/{userId}/greetings/defaults":{"get":{"tags":["Greetings"],"summary":"Grabs the list of Default Greetings given a User's ID","description":"","operationId":"getUserIdGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdGreetingsDefaults"},"put":{"tags":["Greetings"],"summary":"Updates the DefaultGreetingList of the specified User","description":"","operationId":"putUserIdGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated defaultGreetingList","required":true,"schema":{"$ref":"#/definitions/DefaultGreetingList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdGreetingsDefaults"}},"/api/v1/users/{userId}/outofoffice":{"get":{"tags":["Users"],"summary":"Get a OutOfOffice","description":"","operationId":"getUserIdOutofoffice","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutOfOffice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdOutofoffice"},"put":{"tags":["Users"],"summary":"Update an OutOfOffice","description":"","operationId":"putUserIdOutofoffice","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated UserPresence","required":true,"schema":{"$ref":"#/definitions/OutOfOffice"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutOfOffice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdOutofoffice"}},"/api/v1/users/{userId}/presences":{"get":{"tags":["Presence"],"summary":"Get an User's list of Presences","description":"","operationId":"getUserIdPresences","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdPresences"}},"/api/v1/users/{userId}/presences/{source}":{"get":{"tags":["Presence"],"summary":"Get a UserPresence","description":"","operationId":"getUserIdPresencesSource","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"source","in":"path","description":"Source","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdPresencesSource"},"put":{"tags":["Presence"],"summary":"Update a UserPresence","description":"","operationId":"putUserIdPresencesSource","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"source","in":"path","description":"Source","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated UserPresence","required":true,"schema":{"$ref":"#/definitions/UserPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdPresencesSource"},"patch":{"tags":["Presence"],"summary":"Patch a UserPresence","description":"","operationId":"patchUserIdPresencesSource","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"source","in":"path","description":"Source","required":true,"type":"string"},{"in":"body","name":"body","description":"The patched UserPresence","required":true,"schema":{"$ref":"#/definitions/UserPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserIdPresencesSource"}},"/api/v1/users/{userId}/primarypresence":{"get":{"tags":["Presence"],"summary":"Get a user's Primary UserPresence","description":"","operationId":"getUserIdPrimarypresence","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdPrimarypresence"}},"/api/v1/users/{userId}/primarypresencesource":{"get":{"tags":["Users"],"summary":"Get a user's PrimaryUserPresenceSource","description":"","operationId":"getUserIdPrimarypresencesource","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PrimaryUserPresenceSource"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdPrimarypresencesource"},"put":{"tags":["Users"],"summary":"Update a user's PrimaryUserPresenceSource","description":"","operationId":"putUserIdPrimarypresencesource","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PrimaryUserPresenceSource"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PrimaryUserPresenceSource"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdPrimarypresencesource"}},"/api/v1/users/{userId}/queues":{"get":{"tags":["Users"],"summary":"Get queues for user","description":"","operationId":"getUserIdQueues","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdQueues"},"patch":{"tags":["Users"],"summary":"Join or unjoin a set of queues for a user","description":"","operationId":"patchUserIdQueues","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"User Queues","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/UserQueue"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserIdQueues"}},"/api/v1/users/{userId}/queues/{queueId}":{"patch":{"tags":["Users"],"summary":"Join or unjoin a queue for a user","description":"","operationId":"patchUserIdQueuesQueueId","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Member","required":false,"schema":{"$ref":"#/definitions/UserQueue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserIdQueuesQueueId"}},"/api/v1/users/{userId}/roles":{"get":{"tags":["Users"],"summary":"List roles for user","description":"","operationId":"getUserIdRoles","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationRole"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdRoles"}},"/api/v1/users/{userId}/routingstatus":{"get":{"tags":["Users"],"summary":"Fetch the routing status of a user","description":"","operationId":"getUserIdRoutingstatus","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdRoutingstatus"},"put":{"tags":["Users"],"summary":"Update the routing status of a user","description":"","operationId":"putUserIdRoutingstatus","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Routing Status","required":false,"schema":{"$ref":"#/definitions/RoutingStatus"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdRoutingstatus"}},"/api/v1/users/{userId}/skills":{"get":{"tags":["Users"],"summary":"List skills for user","description":"","operationId":"getUserIdSkills","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserSkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdSkills"}},"/api/v1/voicemail/mailbox":{"get":{"tags":["Voicemail"],"summary":"Get mailbox information","description":"","operationId":"getMailbox","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMailboxInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMailbox"}},"/api/v1/voicemail/messages":{"get":{"tags":["Voicemail"],"summary":"List voicemail messages","description":"","operationId":"getMessages","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMessages"},"delete":{"tags":["Voicemail"],"summary":"Delete all voicemail messages","description":"","operationId":"deleteMessages","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteMessages"}},"/api/v1/voicemail/messages/{messageId}":{"get":{"tags":["Voicemail"],"summary":"Get message.","description":"","operationId":"getMessagesMessageId","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMessagesMessageId"},"put":{"tags":["Voicemail"],"summary":"Update a message.","description":"","operationId":"putMessagesMessageId","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"},{"in":"body","name":"body","description":"VoicemailMessage","required":false,"schema":{"$ref":"#/definitions/VoicemailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putMessagesMessageId"},"delete":{"tags":["Voicemail"],"summary":"Delete a message.","description":"","operationId":"deleteMessagesMessageId","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteMessagesMessageId"}},"/api/v1/voicemail/messages/{messageId}/media":{"get":{"tags":["Voicemail"],"summary":"Get media playback URI for this message","description":"","operationId":"getMessagesMessageIdMedia","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired format (WEBM, WAV, etc.)","required":false,"type":"string","default":"WEBM","enum":["WEBM","WAV"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMediaInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMessagesMessageIdMedia"}}},"securityDefinitions":{"PureCloud Auth":{"type":"oauth2","authorizationUrl":"https://auth.us-east-1.mypurecloud.com/authorize","flow":"implicit","scopes":{"all":"All the scopes"}}},"definitions":{"Entity":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string"}}},"UserAuthorization":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"licenses":{"type":"array","items":{"type":"string"}},"roles":{"type":"array","items":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"permissionPolicies":{"type":"array","items":{"$ref":"#/definitions/ResourcePermissionPolicy"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrganizationAddress":{"type":"object","properties":{"display":{"type":"string"},"address":{"type":"string"},"type":{"type":"string","enum":["WORK","HOME","MOBILE","MAIN"]},"mediaType":{"type":"string","enum":["PHONE","EMAIL","SMS"]}}},"Product":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","AVAILABLE","NOT_AVAILABLE","PARTIAL"]},"comments":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeLogsJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"The created job id."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"XlsxSchema":{"type":"object","required":["Name","SheetSchemas"],"properties":{"SheetSchemas":{"type":"array","description":"A list of all the schemas for a XLSX file. Each schema represents a different sheet's schema.","items":{"$ref":"#/definitions/SheetSchema"}},"Name":{"type":"string","description":"Human readable name for schema."},"CarrierId":{"type":"string","description":"Carrier ID associated with this CSV schema.","readOnly":true}}},"CreateShareRequest":{"type":"object","properties":{"sharedEntityType":{"type":"string","enum":["DOCUMENT"]},"sharedEntity":{"$ref":"#/definitions/Entity"},"memberType":{"type":"string","enum":["USER","PUBLIC"]},"member":{"$ref":"#/definitions/Entity"},"members":{"type":"array","items":{"$ref":"#/definitions/CreateShareRequestMember"}}}},"PINConfiguration":{"type":"object","properties":{"minimumLength":{"type":"integer","format":"int32"},"maximumLength":{"type":"integer","format":"int32"}}},"WorkItem":{"type":"object","required":["workItemConfigId","workItemExecId"],"properties":{"workItemExecId":{"type":"string","description":"The work item execution id."},"workItemConfigId":{"type":"string","description":"The work item definition id."},"workItemName":{"type":"string","description":"The work item displayable name."}},"description":"Information about the work item associated with a history item."},"SessionRequest":{"type":"object","properties":{"minutesToLive":{"type":"integer","format":"int64"}}},"BatchReplyItem":{"type":"object","properties":{"code":{"type":"number","format":"double"},"error":{"type":"string"},"body":{"$ref":"#/definitions/BatchItemBody"}}},"AccountOverview":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"isSuperUser":{"type":"boolean","default":false},"hasAccountNumber":{"type":"boolean","default":false},"usageCharges":{"type":"array","items":{"$ref":"#/definitions/Charge"}},"domesticChargesTotal":{"type":"integer","format":"int32"},"internationalChargesTotal":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FacetInfo":{"type":"object","properties":{"name":{"type":"string"},"entries":{"type":"array","items":{"$ref":"#/definitions/Entry"}}}},"DomainOrganizationProduct":{"type":"object","properties":{"id":{"type":"string"}}},"DependencyType":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"versioned":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AcwSettings":{"type":"object","properties":{"wrapupPrompt":{"type":"string","enum":["MANDATORY","OPTIONAL","MANDATORY_TIMEOUT","MANDATORY_FORCED_TIMEOUT"]},"timeoutMs":{"type":"integer","format":"int32"}}},"RuleSet":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"integer","format":"int32"},"contactList":{"$ref":"#/definitions/UriReference"},"queue":{"$ref":"#/definitions/UriReference"},"rules":{"type":"array","items":{"$ref":"#/definitions/Rule"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CarrierAddress":{"type":"object","properties":{"streetAddress1":{"type":"string"},"streetAddress2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zipcode":{"type":"string"}}},"DomainResourceConditionValue":{"type":"object","properties":{"user":{"$ref":"#/definitions/User"},"queue":{"$ref":"#/definitions/Queue"},"value":{"type":"string"},"type":{"type":"string","enum":["SCALAR","VARIABLE","USER","QUEUE"]}}},"Line":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"edgeGroup":{"$ref":"#/definitions/UriReference"},"template":{"$ref":"#/definitions/UriReference"},"site":{"$ref":"#/definitions/UriReference"},"lineBaseSettings":{"$ref":"#/definitions/UriReference"},"primaryEdge":{"$ref":"#/definitions/Edge"},"secondaryEdge":{"$ref":"#/definitions/Edge"},"loggedInUser":{"$ref":"#/definitions/UriReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PermissionCollectionEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionCollection"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TimeZone":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"standardOffset":{"type":"integer","format":"int64"},"offset":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeLogsJobRequest":{"type":"object","properties":{"path":{"type":"string"},"query":{"type":"string"},"recurse":{"type":"boolean","default":false}}},"PutManagementUnit":{"type":"object","properties":{"name":{"type":"string"},"startDayOfWeek":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"timezone":{"type":"string"}}},"Note":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"noteText":{"type":"string"},"modifyDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"createDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"QueueMember":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"ringNumber":{"type":"integer","format":"int32"},"joined":{"type":"boolean","default":false},"memberBy":{"type":"string"},"routingStatus":{"$ref":"#/definitions/RoutingStatus"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VoiceRateUpdate":{"type":"object","required":["amendmentDate","currency","effectiveDate"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"currency":{"type":"string","description":"The ISO 4217 currency code of the voice rate."},"inboundTollFree":{"description":"The inbound toll free rate.","$ref":"#/definitions/VoiceRate"},"extended":{"type":"array","description":"The domestic extended rates.","items":{"$ref":"#/definitions/VoiceRateExtended"}},"inboundTolled":{"description":"The inbound tolled rate.","$ref":"#/definitions/VoiceRate"},"outboundLocal":{"description":"The outbound local rate.","$ref":"#/definitions/VoiceRate"},"outboundIntraState":{"description":"The outbound intra-state rate.","$ref":"#/definitions/VoiceRate"},"outboundInterState":{"description":"The outbound inter-state rate.","$ref":"#/definitions/VoiceRate"},"outboundInternational":{"type":"array","description":"The outbound international rates.","items":{"$ref":"#/definitions/VoiceRateInternational"}},"amendmentDate":{"type":"string","format":"date-time","description":"The date of the rate amendment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"effectiveDate":{"type":"string","format":"date-time","description":"The effective date of the rate amendment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PolicyActions":{"type":"object","properties":{"retainRecording":{"type":"boolean","default":false},"deleteRecording":{"type":"boolean","default":false},"assignEvaluations":{"type":"array","items":{"$ref":"#/definitions/EvaluationAssignment"}},"assignMeteredEvaluations":{"type":"array","items":{"$ref":"#/definitions/MeteredEvaluationAssignment"}},"assignCalibrations":{"type":"array","items":{"$ref":"#/definitions/CalibrationAssignment"}},"retentionDuration":{"$ref":"#/definitions/RetentionDuration"}}},"TimeZoneEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/TimeZone"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AccountManager":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"}}},"SystemPromptAssetEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/SystemPromptAsset"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EvaluatorActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"evaluator":{"$ref":"#/definitions/User"},"numEvaluationsAssigned":{"type":"integer","format":"int32"},"numEvaluationsStarted":{"type":"integer","format":"int32"},"numEvaluationsCompleted":{"type":"integer","format":"int32"},"numCalibrationsAssigned":{"type":"integer","format":"int32"},"numCalibrationsStarted":{"type":"integer","format":"int32"},"numCalibrationsCompleted":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmbeddedSignatureView":{"type":"object","properties":{"view":{"$ref":"#/definitions/View"}}},"FaxSendRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"addresses":{"type":"array","items":{"type":"string"}},"originalFilename":{"type":"string"},"contentType":{"type":"string"},"workspace":{"$ref":"#/definitions/Workspace"},"coverSheet":{"$ref":"#/definitions/CoverSheet"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WrapUpCodeMapping":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"integer","format":"int32"},"defaultSet":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["CONTACT_UNCALLABLE","NUMBER_UNCALLABLE","RIGHT_PARTY_CONTACT"]}},"mapping":{"type":"object","additionalProperties":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["CONTACT_UNCALLABLE","NUMBER_UNCALLABLE","RIGHT_PARTY_CONTACT"]}}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Greeting":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","enum":["STATION","VOICEMAIL","NAME"]},"ownerType":{"type":"string","enum":["USER","ORGANIZATION"]},"owner":{"$ref":"#/definitions/DomainEntity"},"audioFile":{"$ref":"#/definitions/GreetingAudioFile"},"audioTTS":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"createdBy":{"type":"string","format":"uri"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AuditMessage":{"type":"object","properties":{"id":{"type":"string"},"user":{"$ref":"#/definitions/User"},"correlationId":{"type":"string"},"transactionId":{"type":"string"},"transactionInitiator":{"type":"boolean","default":false},"application":{"type":"string"},"serviceName":{"type":"string"},"level":{"type":"string"},"timestamp":{"type":"string"},"receivedTimestamp":{"type":"string"},"status":{"type":"string"},"actionContext":{"type":"string"},"action":{"type":"string"},"changes":{"type":"array","items":{"$ref":"#/definitions/Change"}},"entity":{"$ref":"#/definitions/Entity"},"serviceContext":{"$ref":"#/definitions/ServiceContext"}}},"ServerDate":{"type":"object","properties":{"currentDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"SkillsToRemove":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"ScheduleGroup":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"timeZone":{"type":"string"},"openSchedules":{"type":"array","items":{"$ref":"#/definitions/UriReference"}},"closedSchedules":{"type":"array","items":{"$ref":"#/definitions/UriReference"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeLineEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/EdgeLine"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ProvisionInfo":{"type":"object","properties":{"time":{"type":"string","format":"date-time","description":"The time at which this phone was provisioned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"source":{"type":"string","description":"The source of the provisioning"},"errorInfo":{"type":"string","description":"The error information from the provision process, if any"}}},"ClientSpreadsheetTransform":{"type":"object","properties":{"id":{"type":"string"},"endpointId":{"type":"string"},"filenameReplaces":{"type":"array","items":{"$ref":"#/definitions/BasicTransform"}},"tags":{"type":"array","items":{"$ref":"#/definitions/TagModel"}},"name":{"type":"string"},"sheetNameReplaces":{"type":"array","items":{"$ref":"#/definitions/IndexedTransform"}},"sheets":{"type":"array","items":{"$ref":"#/definitions/SheetTransform"}}}},"Entry":{"type":"object","properties":{"value":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"WorkItemTransferRequest":{"type":"object","required":["transferTarget","transferTargetType"],"properties":{"transferTargetType":{"type":"string","description":"The type of the transferTarget, indicating whether you want to transfer to a User, or a Queue, etc.","enum":["USER","QUEUE"]},"transferTarget":{"type":"string","description":"The destination to where the work item should be transferred."}},"description":"Used as the body to the transferWorkItem request."},"ResourcePermissionPolicy":{"type":"object","properties":{"orgId":{"type":"string"},"id":{"type":"string"},"domain":{"type":"string"},"entityName":{"type":"string"},"policyName":{"type":"string"},"policyDescription":{"type":"string"},"actionSetKey":{"type":"string"},"resourceConditionNode":{"$ref":"#/definitions/ResourceConditionNode"},"namedResources":{"type":"array","items":{"type":"string"}},"resourceCondition":{"type":"string"},"actionSet":{"type":"array","uniqueItems":true,"items":{"type":"string"}}}},"FacetTerm":{"type":"object","properties":{"term":{"type":"string"},"key":{"type":"integer","format":"int64"},"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer","format":"int64"},"time":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"BatchItem":{"type":"object","properties":{"method":{"type":"string"},"url":{"type":"string"},"body":{"$ref":"#/definitions/BatchItemBody"}}},"ExpressionResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation date for the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date the entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"socialHub":{"type":"string","description":"The name of the social hub."},"conversation":{"description":"The conversation that this response is a part of.","$ref":"#/definitions/Conversation"},"twitterExpression":{"description":"The twitter expression that this is in response to.","$ref":"#/definitions/TwitterExpression"},"rawResponseText":{"type":"string","description":"The raw text of the response."},"socialAccount":{"description":"The Social Account used to publish this expression","$ref":"#/definitions/SocialAccount"},"socialHubResponseId":{"type":"string","description":"The id given to this response from the social hub"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ReplaceResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"changeNumber":{"type":"integer","format":"int32"},"uploadStatus":{"$ref":"#/definitions/UriReference"},"uploadDestinationUri":{"type":"string","format":"uri"},"uploadMethod":{"type":"string","enum":["SINGLE_PUT","MULTIPART_POST"]}}},"Queue":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/UriReference"}},"mediaSettings":{"type":"object","additionalProperties":{"$ref":"#/definitions/MediaSetting"}},"bullseye":{"$ref":"#/definitions/Bullseye"},"acwSettings":{"$ref":"#/definitions/AcwSettings"},"phoneNumber":{"type":"string"},"skillEvaluationMethod":{"type":"string","enum":["NONE","BEST","ALL"]},"queueFlow":{"$ref":"#/definitions/UriReference"},"callingPartyName":{"type":"string"},"callingPartyNumber":{"type":"string"},"memberCount":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QualityAudit":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"timestamp":{"type":"string"},"level":{"type":"string"},"entity":{"$ref":"#/definitions/Entity"},"action":{"type":"string"},"status":{"type":"string"},"entityType":{"type":"string"},"changes":{"type":"array","items":{"$ref":"#/definitions/Change"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DID":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"phoneNumber":{"type":"string"},"didPool":{"$ref":"#/definitions/UriReference"},"owner":{"description":"A Uri reference to the owner of this DID, which is either a User or an IVR","$ref":"#/definitions/UriReference"},"ownerType":{"type":"string","enum":["USER","PHONE","IVR_CONFIG","GROUP"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ManagementUnit":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"startDayOfWeek":{"type":"string"},"timezone":{"type":"string"},"version":{"type":"integer","format":"int32"}}},"WorkspaceMember":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"workspace":{"$ref":"#/definitions/UriReference"},"memberType":{"type":"string","enum":["USER","GROUP"]},"member":{"$ref":"#/definitions/UriReference"},"user":{"$ref":"#/definitions/User"},"group":{"$ref":"#/definitions/Group"},"securityProfile":{"$ref":"#/definitions/SecurityProfile"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EncryptionKeyEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/EncryptionKey"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"NoteListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Note"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainOrgRoleDifference":{"type":"object","properties":{"removedPermissionPolicies":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"addedPermissionPolicies":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"samePermissionPolicies":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"userOrgRole":{"$ref":"#/definitions/DomainOrganizationRole"},"roleFromDefault":{"$ref":"#/definitions/DomainOrganizationRole"}}},"EdgeLine":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"schema":{"$ref":"#/definitions/UriReference"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"edge":{"$ref":"#/definitions/Edge"},"edgeGroup":{"$ref":"#/definitions/EdgeGroup"},"lineType":{"type":"string","enum":["TIE","NETWORK","TRUNK","STATION"]},"endpoint":{"$ref":"#/definitions/Endpoint"},"ipAddress":{"type":"string"},"logicalInterfaceId":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LibraryEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Library"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RuleEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Rule"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CertificateAuthorityEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DomainCertificateAuthority"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainNetworkRoute":{"type":"object","properties":{"prefix":{"type":"string"},"nexthop":{"type":"string"},"persistent":{"type":"boolean","default":false},"metric":{"type":"integer","format":"int32"},"family":{"type":"integer","format":"int32"}}},"TrunkMetabaseEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Metabase"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SharedResponse":{"type":"object","properties":{"id":{"type":"string"},"downloadUri":{"type":"string","format":"uri"},"viewUri":{"type":"string","format":"uri"},"document":{"$ref":"#/definitions/Document"},"share":{"$ref":"#/definitions/Share"}}},"Relationship":{"type":"object","required":["externalOrganization","relationship","user"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"description":"The user associated with the external organization","$ref":"#/definitions/User"},"externalOrganization":{"description":"The external organization this relationship is attached to","$ref":"#/definitions/ExternalOrganization"},"relationship":{"type":"string","description":"The relationship or role of the user to this external organization.Examples: Account Manager, Sales Engineer, Implementation Consultant"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ReportRunEntry":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"reportId":{"type":"string"},"runTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"runStatus":{"type":"string","enum":["RUNNING","COMPLETED","COMPLETED_WITH_ERRORS"]},"errorMessage":{"type":"string"},"runDurationMsec":{"type":"integer","format":"int64"},"reportUrl":{"type":"string"},"reportFormat":{"type":"string"},"scheduleUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Parameter":{"type":"object","properties":{"name":{"type":"string"},"parameterType":{"type":"string","enum":["UUID","STRING","UUIDLIST","STRINGLIST"]},"domain":{"type":"string","enum":["USERID","QUEUEID","MEDIATYPE","DIALERCAMPAIGNID","QMEVALFORMID","UNKNOWN"]},"required":{"type":"boolean","default":false}}},"DialerDispositionCallCommand":{"type":"object","properties":{"callId":{"type":"string"},"wrapupCodeId":{"type":"string"},"contact":{"$ref":"#/definitions/Contact"}}},"SubDataItem":{"type":"object","required":["displayValue","id","prompt","type","value"],"properties":{"id":{"type":"string","description":"The id of this element"},"type":{"type":"string","description":"The 'type' of the element, this may be a system value, EG 'STRING' or a user defined type"},"value":{"type":"string","description":"The value of the element itself - This may be a simple value or more complex serialized data."},"prompt":{"type":"string","description":"The prompt displayed to the user that this data item was set from."},"displayValue":{"type":"string","description":"The display value that was offered to the user (as opposed to the actual value used internally"}},"description":"An additional data element that was set by the user for this event."},"ConversationQueryResponse":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Conversation"}},"hasMorePrev":{"type":"boolean","default":false},"hasMoreNext":{"type":"boolean","default":false},"startQueryTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"endQueryTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"newestResultTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"oldestResultTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"timeMs":{"type":"integer","format":"int64"},"iterations":{"type":"integer","format":"int32"},"anchor":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"sort":{"type":"string","enum":["ASC","DESC"]},"facets":{"$ref":"#/definitions/Facets"},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainEdgeSoftwareUpdateDto":{"type":"object","properties":{"version":{"$ref":"#/definitions/DomainEdgeSoftwareVersionDto"},"maxDownloadRate":{"type":"integer","format":"int32"},"downloadStartTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"executeStartTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"executeStopTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"executeOnIdle":{"type":"boolean","default":false},"status":{"type":"string","enum":["NONE","INIT","IN_PROGRESS","EXPIRED","EXCEPTION","ABORTED","FAILED","SUCCEEDED","DELETE"]},"edgeUri":{"type":"string","format":"uri"},"current":{"type":"boolean","default":false}}},"CampaignSequence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"integer","format":"int32"},"campaigns":{"type":"array","items":{"$ref":"#/definitions/UriReference"}},"currentCampaign":{"type":"integer","format":"int32"},"status":{"type":"string","enum":["ON","OFF","COMPLETE"]},"stopMessage":{"type":"string"},"repeat":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SignatureDocumentInfo":{"type":"object","properties":{"org":{"$ref":"#/definitions/Organization"},"user":{"$ref":"#/definitions/User"},"returnUrl":{"type":"string"}}},"CalibrationAssignment":{"type":"object","properties":{"calibrator":{"$ref":"#/definitions/User"},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"expertEvaluator":{"$ref":"#/definitions/User"}}},"WrapupCodeEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeVersionReport":{"type":"object","properties":{"oldestVersion":{"$ref":"#/definitions/EdgeVersionInformation"},"newestVersion":{"$ref":"#/definitions/EdgeVersionInformation"}}},"Email":{"type":"object","properties":{"state":{"type":"string","enum":["ALERTING","CONNECTED","DISCONNECTED","NONE"]},"id":{"type":"string"},"held":{"type":"boolean","default":false},"subject":{"type":"string"},"messagesSent":{"type":"integer","format":"int32"},"segments":{"type":"array","items":{"$ref":"#/definitions/Segment"}},"direction":{"type":"string","enum":["INBOUND","OUTBOUND"]},"recordingId":{"type":"string"},"errorInfo":{"$ref":"#/definitions/ErrorBody"},"disconnectType":{"type":"string","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"startHoldTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"connectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"ExpansionCriterium":{"type":"object","properties":{"type":{"type":"string","enum":["TIMEOUT_SECONDS"]},"threshold":{"type":"number","format":"double"}}},"CampaignSchedule":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"integer","format":"int32"},"intervals":{"type":"array","items":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"end":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}}},"timeZone":{"type":"string"},"campaign":{"$ref":"#/definitions/UriReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QuoteCharge":{"type":"object","required":["chargeType","discount","effectivePrice","id","listPriceDisplay","listTotal","name","productShippable","quantity","shippingAddress","sku","total"],"properties":{"id":{"type":"string","description":"The quote charge Id."},"sku":{"type":"string","description":"The quote charge SKU."},"name":{"type":"string","description":"The quote charge name."},"chargeType":{"type":"string","description":"The quote charge type."},"quantity":{"type":"integer","format":"int32","description":"The quote charge quantity."},"listTotal":{"type":"string","description":"The quote charge total price before discounts."},"total":{"type":"string","description":"The quote charge total price after discounts."},"listPriceDisplay":{"type":"string","description":"The quote charge list price before discounts."},"discount":{"type":"string","description":"The quote charge discount percent."},"effectivePrice":{"type":"string","description":"The quote charge list price after discounts."},"productShippable":{"type":"boolean","description":"Indicates whether the product can be shipped.","default":false},"shippingAddress":{"description":"The quote shipping address.","$ref":"#/definitions/Address"},"forRelatedPart":{"type":"string","description":"The part number of a part related to the quote charge."}}},"SystemPromptAsset":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"promptId":{"type":"string"},"language":{"type":"string"},"durationSeconds":{"type":"number","format":"double"},"mediaUri":{"type":"string"},"ttsString":{"type":"string"},"uploadUri":{"type":"string"},"uploadStatus":{"type":"string","enum":["CREATED","UPLOADED","TRANSCODED"]},"hasDefault":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DIDPool":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"startPhoneNumber":{"type":"string","description":"The starting phone number for the range of this DID pool. Must be in E.164 format"},"endPhoneNumber":{"type":"string","description":"The ending phone number for the range of this DID pool. Must be in E.164 format"},"comments":{"type":"string"},"provider":{"type":"string","description":"The provider for this DID pool","enum":["PURE_CLOUD","PURE_CLOUD_VOICE"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Attachment":{"type":"object","properties":{"attachmentId":{"type":"string"},"name":{"type":"string"},"contentUri":{"type":"string"},"contentType":{"type":"string"},"contentLength":{"type":"integer","format":"int32"}}},"DiagnosticEmail":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"subject":{"type":"string"},"topic":{"type":"string"},"description":{"type":"string"},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"type":{"type":"string","enum":["PROBLEM","FEATURE_REQUEST","QUESTION","TECHNICAL_ISSUE","NON_TECHNICAL_ISSUE"]},"data":{"type":"object"}}},"OAuthProvider":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SortField":{"type":"object","properties":{"name":{"type":"string"},"sortType":{"type":"string","enum":["ASCENDING","DESCENDING"]}}},"TemplateEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Template"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportMetaData":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"keywords":{"type":"array","items":{"type":"string"}},"availableLocales":{"type":"array","items":{"type":"string"}},"parameters":{"type":"array","items":{"$ref":"#/definitions/Parameter"}},"exampleUrl":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrunkBaseAssignment":{"type":"object","properties":{"family":{"type":"integer","format":"int32","description":"The address family to use with the trunk base settings. 2=IPv4, 23=IPv6"},"trunkBase":{"description":"A trunk base settings reference.","$ref":"#/definitions/UriReference"}}},"ExternalOrganizationListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalOrganization"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RuleSetEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/RuleSet"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainSchemaReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowConfigId":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"version":{"type":"string","description":"Version of this flow config."}},"description":"ID of a Flow Definition with an optional version"},"UserSkillEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/UserSkill"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WorkspaceMemberEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/WorkspaceMember"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainVoiceRateResponseItemEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/VoiceRate"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ErrorBody":{"type":"object","properties":{"status":{"type":"integer","format":"int32"},"code":{"type":"string"},"entityId":{"type":"string"},"entityName":{"type":"string"},"message":{"type":"string"},"messageWithParams":{"type":"string"},"messageParams":{"type":"object","additionalProperties":{"type":"string"}},"contextId":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/definitions/Detail"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ErrorBody"}}}},"OrganizationCreate":{"type":"object","required":["adminPassword","adminUsername","domain","name","thirdPartyOrgName"],"properties":{"name":{"type":"string","description":"Display Name for Organization"},"adminUsername":{"type":"string","description":"Administrator username for this organization"},"adminPassword":{"type":"string","description":"Administrator password for this organization"},"domain":{"type":"string","description":"Fully qualified domain name for this organization (Ex. example.com)."},"thirdPartyOrgName":{"type":"string","description":"Organization Name which does not contain special characters like spaces."},"deletable":{"type":"boolean","description":"Deletable Property for Organization.","default":false}},"description":"Creating an Organization"},"FaxSendResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"uploadDestinationUri":{"type":"string","format":"uri"},"uploadMethodType":{"type":"string","enum":["SINGLE_PUT","MULTIPART_POST"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ChatMessage":{"type":"object","properties":{"body":{"type":"string"},"id":{"type":"string"},"to":{"type":"string"},"from":{"type":"string"},"utc":{"type":"string"},"chat":{"type":"string"},"message":{"type":"string"},"type":{"type":"string"},"user":{"$ref":"#/definitions/ChatMessageUser"}}},"WorkItemCache":{"type":"object","properties":{"workItemExecId":{"type":"string","description":"The workItem instance ID that owns this cache."},"saveTime":{"type":"string","format":"date-time","description":"The time that the workItem cache was last saved. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"saveUser":{"description":"The user that last saved the workItem cache.","$ref":"#/definitions/User"},"saveComment":{"type":"string","description":"An optional comment made during the last save"},"dataItems":{"type":"array","description":"The data items that are present within the cache.","items":{"$ref":"#/definitions/DataItem"}}}},"CustomerAccount":{"type":"object","required":["billingAddress","currency","isFrozen","isTaxExempt","orgLegalName","orgPhone"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"isFrozen":{"type":"boolean","description":"Indicates whether the account is currently frozen for review.","default":false},"orgLegalName":{"type":"string","description":"The organization legal name."},"orgPhone":{"type":"string","description":"The organization phone number."},"isTaxExempt":{"type":"boolean","description":"Indicates whether the account is tax exempt.","default":false},"billingAddress":{"description":"The account billing address.","$ref":"#/definitions/Address"},"currency":{"type":"string","description":"The account currency."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SocializeFilterRequest":{"type":"object","properties":{"filters":{"type":"array","description":"The list of filters used to narrow the return.","items":{"$ref":"#/definitions/SocializeEntityFilter"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"sortBy":{"type":"string"},"sortOrder":{"type":"string","enum":["ascending","descending"]}}},"FlowUploadResponse":{"type":"object","properties":{"uri":{"type":"string","format":"uri","description":"uri destination to upload file to"},"uploadToken":{"type":"string","description":"token to send along when creating versioned flow so the file can be bound to the metadata"}},"description":"Data containing details to upload a flow definition to for post versioned flows."},"TransformModel":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"restEndpoint":{"$ref":"#/definitions/TransformEndpoint"},"filenameTransforms":{"type":"array","items":{"$ref":"#/definitions/BasicTransform"}},"tags":{"type":"array","items":{"$ref":"#/definitions/TagModel"}},"clientTransformModel":{"$ref":"#/definitions/ClientTransformModel"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MeteredEvaluationAssignment":{"type":"object","properties":{"evaluationContextId":{"type":"string"},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"maxNumberEvaluations":{"type":"integer","format":"int32"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"assignToActiveUser":{"type":"boolean","default":false},"timeInterval":{"$ref":"#/definitions/TimeInterval"}}},"DeletedResourceConsumerEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DependencyObject"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Video":{"type":"object","properties":{"state":{"type":"string","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","NONE"]},"id":{"type":"string"},"context":{"type":"string"},"audioMuted":{"type":"boolean","default":false},"videoMuted":{"type":"boolean","default":false},"sharingScreen":{"type":"boolean","default":false},"peerCount":{"type":"integer","format":"int32"},"disconnectType":{"type":"string","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"connectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"MediaSetting":{"type":"object","properties":{"alertingTimeoutSeconds":{"type":"integer","format":"int32"},"serviceLevel":{"$ref":"#/definitions/ServiceLevel"}}},"DomainLicense":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"product":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AgentActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"agent":{"$ref":"#/definitions/User"},"numEvaluations":{"type":"integer","format":"int32"},"averageEvaluationScore":{"type":"integer","format":"int32"},"agentEvaluatorActivityList":{"type":"array","items":{"$ref":"#/definitions/AgentEvaluatorActivity"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DependencyTypeEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DependencyType"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ConsultTransfer":{"type":"object","required":["destination"],"properties":{"speakTo":{"type":"string","description":"Determines to whom the initiating participant is speaking. Defaults to DESTINATION","enum":["DESTINATION","OBJECT","BOTH"]},"destination":{"description":"Destination phone number and name.","$ref":"#/definitions/Destination"}}},"SearchRequest":{"type":"object","properties":{"searchPhrase":{"type":"string","description":"The search text to look for"},"pageNumber":{"type":"integer","format":"int32","description":"The pageNumber to get results from (EG If there are 100 results with a pageSize of 10 and pageNumber is 3 then 10 results will be returned starting with index #31"},"pageSize":{"type":"integer","format":"int32","description":"Number of entries to return/calculate per page."},"searchFields":{"type":"array","description":"The fields to limit the searchPhrase search to","items":{"type":"string"}},"facetRequests":{"type":"array","description":"List of facet requests to generate summary views from the search result set (if any)","items":{"$ref":"#/definitions/FacetRequest"}},"sort":{"type":"array","description":"sort the results on a field(s)","items":{"$ref":"#/definitions/SortField"}},"filters":{"type":"array","description":"You can also restrict the search to particular field values and ranges","items":{"$ref":"#/definitions/FilterItem"}}},"description":"Used to perform a search on various data stored in search engines"},"QueuesEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/AutomateQueue"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WorkspaceEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Workspace"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"VoicemailOrganizationPolicy":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"retentionTimeDays":{"type":"integer","format":"int32"},"alertTimeoutSeconds":{"type":"integer","format":"int32"},"minimumRecordingTimeSeconds":{"type":"integer","format":"int32"},"maximumRecordingTimeSeconds":{"type":"integer","format":"int32"},"unavailableMessageUri":{"type":"string","format":"uri"},"namePromptMessageUri":{"type":"string","format":"uri"},"fullMessageUri":{"type":"string","format":"uri"},"compressSilence":{"type":"boolean","default":false},"pinConfiguration":{"$ref":"#/definitions/PINConfiguration"},"quotaSizeBytes":{"type":"integer","format":"int64"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"voicemailExtension":{"type":"string","description":"The extension for voicemail retrieval.  The default value is *86."},"pinRequired":{"type":"boolean","description":"If this is true, a PIN is required when accessing a user's voicemail from a phone.","default":false}}},"IVR":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"ivrUri":{"type":"string"},"dnis":{"type":"array","items":{"type":"string"}},"flowId":{"type":"string"},"scheduleId":{"type":"string"},"openHoursFlow":{"$ref":"#/definitions/UriReference"},"closedHoursFlow":{"$ref":"#/definitions/UriReference"},"scheduleGroup":{"$ref":"#/definitions/UriReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Form":{"type":"object","properties":{"controls":{"type":"array","items":{"$ref":"#/definitions/Control"}}}},"EvaluationScoringSet":{"type":"object","properties":{"totalScore":{"type":"number","format":"float"},"totalCriticalScore":{"type":"number","format":"float"},"questionGroupScores":{"type":"array","items":{"$ref":"#/definitions/QuestionGroupScore"}},"anyFailedKillQuestions":{"type":"boolean","default":false},"comments":{"type":"string"},"agentComments":{"type":"string"}}},"CampaignSequenceEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/CampaignSequence"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CoverSheet":{"type":"object","properties":{"notes":{"type":"string","description":"Text to be added to the coversheet"},"locale":{"type":"string","description":"Locale, e.g. = en-US"}}},"Gistener":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation date for the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date the entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"enabled":{"type":"boolean","description":"Indicates if this Gistener may be utilized on another entity","default":false},"anyWords":{"type":"string","description":"A tweet must contain any one of these words"},"allWords":{"type":"string","description":"A tweet must contain every one of these words in any order"},"excludeWords":{"type":"string","description":"If a tweet contains any one of these words, it is thrown out"},"exactPhrase":{"type":"string","description":"A tweet must contain this exact quoted phrase"},"groupTags":{"type":"array","description":"The group tags associated with this Gistener","items":{"$ref":"#/definitions/GroupTag"}},"socialAccount":{"description":"The social account associated with this Gistener","$ref":"#/definitions/SocialAccount"},"queue":{"description":"The operator queue the gistener will route to.","$ref":"#/definitions/Queue"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AttributeEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Attribute"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Language":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"state":{"type":"string","enum":["ACTIVE","INACTIVE","DELETED"]},"version":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Number":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}}},"ConversationHistoricalQueryRequestBody":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32","description":"Maximum number of conversations returned. Overrides 'maximum' if both specified. Default 100"},"maximum":{"type":"integer","format":"int32","description":"Maximum number of conversations returned"},"filters":{"type":"array","description":"Query filters. Default is all conversations for the previous 7 days","items":{"$ref":"#/definitions/ConversationHistoricalQueryRequestFilter"}},"facets":{"type":"array","description":"Facets to return. Currently, only 'queue' is supported","items":{"type":"string"}}},"description":"Historical conversation request parameters"},"Vpn":{"type":"object","properties":{"type":{"type":"string"},"ip":{"type":"string"},"psk":{"type":"string"}}},"FlowBody":{"type":"object","properties":{"format":{"type":"string","description":"The 'format' indicates the particular format of the 'body' contents.  Reference the Automate documentation for format information."},"body":{"type":"object","description":"The flow definition body according to the syntax supported by the 'format'.  Use the /processautomation/flows/schemas endpoint to get detailed syntax information for each format.","additionalProperties":{"type":"object"}}}},"BackendFlowAvailableActions":{"type":"object","properties":{"canTerminate":{"type":"boolean","default":false}}},"EmailSetup":{"type":"object","properties":{"rootDomain":{"type":"string","description":"The root PureCloud domain that all sub-domains are created from."}}},"Salesforce":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"certificate":{"type":"string"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DeltaResponse":{"type":"object","properties":{"contextToken":{"type":"string"},"documents":{"type":"array","items":{"$ref":"#/definitions/DeltaDocument"}},"hasMore":{"type":"boolean","default":false}}},"Condition":{"type":"object","properties":{"type":{"type":"string"},"inverted":{"type":"boolean","default":false},"attributeName":{"type":"string"},"value":{"type":"string"},"valueType":{"type":"string","enum":["STRING","NUMERIC","DATETIME","PERIOD"]},"operator":{"type":"string","enum":["EQUALS","LESS_THAN","LESS_THAN_EQUALS","GREATER_THAN","GREATER_THAN_EQUALS","CONTAINS","BEGINS_WITH","ENDS_WITH","BEFORE","AFTER"]},"codes":{"type":"array","items":{"type":"string"}}}},"OAuthProviderEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OAuthProvider"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PromptAsset":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"promptId":{"type":"string"},"language":{"type":"string"},"mediaUri":{"type":"string"},"ttsString":{"type":"string"},"uploadStatus":{"type":"string"},"uploadUri":{"type":"string"},"durationSeconds":{"type":"number","format":"double"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FacetResultItem":{"type":"object","properties":{"name":{"type":"string","description":"For TERM facets this will contain the value of the term that was found userid, docid, etc."},"count":{"type":"integer","format":"int64","description":"The number of items that matched the facetRequest."},"document":{"$ref":"#/definitions/Document"},"user":{"$ref":"#/definitions/User"},"queue":{"$ref":"#/definitions/Queue"},"flowConfigId":{"$ref":"#/definitions/FlowConfigId"},"workspace":{"$ref":"#/definitions/Workspace"}}},"EmailAttachment":{"type":"object","properties":{"name":{"type":"string"},"contentPath":{"type":"string"},"contentType":{"type":"string"},"attachmentId":{"type":"string"},"contentLength":{"type":"integer","format":"int32"}}},"FlowHistoryResultItemEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/FlowHistoryResultItem"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AutomateQueueMemberEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/AutomateQueueMember"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RecordingSettings":{"type":"object","properties":{"maxSimultaneousStreams":{"type":"integer","format":"int32"}}},"ContentQueryRequest":{"type":"object","properties":{"queryPhrase":{"type":"string"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"facetNameRequests":{"type":"array","items":{"type":"string"}},"sort":{"type":"array","items":{"$ref":"#/definitions/ContentSortItem"}},"filters":{"type":"array","items":{"$ref":"#/definitions/ContentFacetFilterItem"}},"attributeFilters":{"type":"array","items":{"$ref":"#/definitions/ContentAttributeFilterItem"}}}},"DomainPhysicalCapabilities":{"type":"object","properties":{"vlan":{"type":"boolean","default":false},"team":{"type":"boolean","default":false}}},"ChatSearchRequest":{"type":"object","required":["order","query"],"properties":{"query":{"type":"string","description":"Search terms can be AND'd together. Example: foo AND bar"},"order":{"type":"string","description":"Sort order of results by score or most recent. Default is by score","enum":["SCORE","RECENT"]},"targetJids":{"type":"array","description":"A list of XMPP JIDs to consider. Default is all permissible JIDs. A permissible JID is defined as any JID of a person with whom you have chatted, or any group in which you are currently a member.","items":{"type":"string"}},"pageSize":{"type":"integer","format":"int32","description":"The maximum number of hits to receive in the response. Default: 10, Maximum: 50]"},"pageNumber":{"type":"integer","format":"int32","description":"The number of hits to skip before returning results. Default: 0"},"fromDate":{"type":"string","format":"date-time","description":"Consider hits after this date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"toDate":{"type":"string","format":"date-time","description":"Consider hits before this date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"expand":{"type":"string","description":"Expand the 'to' or 'from' user details.","enum":["to","from"]}}},"FilterItem":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST","GROUP"]},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","ORGROUP","ANDGROUP","NOTGROUP"]},"values":{"type":"array","items":{"type":"string"}},"filters":{"type":"array","items":{"$ref":"#/definitions/FilterItem"}}}},"ReportScheduleEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ReportSchedule"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainInvoiceEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Invoice"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"QuoteListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Quote"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Schedule":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"start":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"end":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"rrule":{"type":"string","description":"An iCal Recurrence Rule (RRULE) string"},"keywords":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VoiceRatesCsv":{"type":"object","required":["name","url"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the rate csv."},"url":{"type":"string","description":"The url of the rate csv."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrgMediaUtilization":{"type":"object","properties":{"maximumCapacity":{"type":"integer","format":"int32","description":"Defines the maximum number of conversations of this type that an agent can handle at one time."},"interruptableMediaTypes":{"type":"array","description":"Defines the list of other media types that can interrupt a conversation of this media type.  Values can be: call, chat, email, or socialExpression","items":{"type":"string"}}}},"QuestionGroupScore":{"type":"object","properties":{"questionGroupId":{"type":"string"},"totalScore":{"type":"number","format":"float"},"maxTotalScore":{"type":"number","format":"float"},"totalCriticalScore":{"type":"number","format":"float"},"maxTotalCriticalScore":{"type":"number","format":"float"},"totalScoreUnweighted":{"type":"number","format":"float"},"maxTotalScoreUnweighted":{"type":"number","format":"float"},"totalCriticalScoreUnweighted":{"type":"number","format":"float"},"maxTotalCriticalScoreUnweighted":{"type":"number","format":"float"},"markedNA":{"type":"boolean","default":false},"questionScores":{"type":"array","items":{"$ref":"#/definitions/QuestionScore"}}}},"VoiceXmlOperationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/VoiceXmlOperation"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ThirdPartyAccount":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"accountNumber":{"type":"string"},"currency":{"type":"string"},"invoices":{"type":"array","items":{"$ref":"#/definitions/Invoice"}},"subscriptions":{"type":"array","items":{"$ref":"#/definitions/ThirdPartySubscription"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AssociatedDocument":{"type":"object","required":["document"],"properties":{"document":{"description":"the document associated with the workitem","$ref":"#/definitions/Document"},"documentAssociationType":{"type":"string","description":"the document association type","enum":["UNKNOWN","MAIN","SECONDARY"]}},"description":"Contains information about the Document associated with a workItem"},"IntegrationTypeEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/IntegrationType"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Address":{"type":"object","properties":{"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"countryCode":{"type":"string"}}},"FacetFilterItem":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST"]},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","CONTAINS"]},"values":{"type":"array","items":{"type":"string"}}}},"UserQueueEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/UserQueue"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ParticipantAttributes":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"type":"string"}}}},"AuditSearchResult":{"type":"object","properties":{"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"pageCount":{"type":"integer","format":"int32"},"facetInfo":{"type":"array","items":{"$ref":"#/definitions/FacetInfo"}},"auditMessages":{"type":"array","items":{"$ref":"#/definitions/AuditMessage"}}}},"Dns":{"type":"object","properties":{"id":{"type":"string"},"ip":{"type":"string"},"port":{"type":"integer","format":"int32"}}},"License":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"}}},"UserQueue":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/UriReference"}},"mediaSettings":{"type":"object","additionalProperties":{"$ref":"#/definitions/MediaSetting"}},"bullseye":{"$ref":"#/definitions/Bullseye"},"acwSettings":{"$ref":"#/definitions/AcwSettings"},"phoneNumber":{"type":"string"},"skillEvaluationMethod":{"type":"string","enum":["NONE","BEST","ALL"]},"queueFlow":{"$ref":"#/definitions/UriReference"},"callingPartyName":{"type":"string"},"callingPartyNumber":{"type":"string"},"joined":{"type":"boolean","default":false},"memberCount":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AuditChange":{"type":"object","properties":{"property":{"type":"string"},"entity":{"$ref":"#/definitions/AuditEntityReference"},"oldValues":{"type":"array","items":{"type":"string"}},"newValues":{"type":"array","items":{"type":"string"}}}},"ClientTextTableTransform":{"type":"object","properties":{"id":{"type":"string"},"endpointId":{"type":"string"},"filenameReplaces":{"type":"array","items":{"$ref":"#/definitions/BasicTransform"}},"tags":{"type":"array","items":{"$ref":"#/definitions/TagModel"}},"name":{"type":"string"},"comments":{"type":"string"},"delimiter":{"type":"string"},"table":{"$ref":"#/definitions/TableTransform"}}},"DomainVoiceRateExtendedResponseItemEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/VoiceRateExtended"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"HardwareRateListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/HardwareRate"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DialerPreview":{"type":"object","properties":{"id":{"type":"string"},"contactId":{"type":"string"},"contactListId":{"type":"string"},"campaignId":{"type":"string"},"phoneNumberColumns":{"type":"array","items":{"$ref":"#/definitions/PhoneNumberColumn"}}}},"UriReference":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"Agent":{"type":"object","properties":{"stage":{"type":"string"}}},"EdgeGroup":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"managed":{"type":"boolean","description":"Is this edge group being managed remotely.","default":false},"edgeTrunkBaseAssignment":{"description":"A trunk base settings assignment of trunkType \"EDGE\" to use for edge-to-edge communication.","$ref":"#/definitions/TrunkBaseAssignment"},"phoneTrunkBaseAssignments":{"type":"array","description":"Trunk base settings assignments of trunkType \"PHONE\" to inherit to edge logical interfaces for phone communication.","items":{"$ref":"#/definitions/TrunkBaseAssignment"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationAssignment":{"type":"object","properties":{"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"user":{"$ref":"#/definitions/User"}}},"OutboundRoute":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"site":{"$ref":"#/definitions/Site"},"classificationTypes":{"type":"array","items":{"type":"string"}},"enabled":{"type":"boolean","default":false},"distribution":{"type":"string","enum":["SEQUENTIAL","RANDOM"]},"managed":{"type":"boolean","default":false},"externalTrunkBases":{"type":"array","description":"Trunk base settings of trunkType \"EXTERNAL\".  This base must also be set on an edge logical interface for correct routing.","items":{"$ref":"#/definitions/UriReference"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BillingPeriod":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"startDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"endDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Actions":{"type":"object","properties":{"skillsToRemove":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/SkillsToRemove"}}}},"Rate":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"partNumber":{"type":"string"},"tiers":{"type":"array","items":{"$ref":"#/definitions/Tier"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Publication":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation date for the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date the entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"tweetText":{"type":"string","description":"The text of the tweet."},"rawTweetText":{"type":"string","description":"The raw text of the tweet"},"approved":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TextTableTransform":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"restEndpoint":{"$ref":"#/definitions/TransformEndpoint"},"filenameTransforms":{"type":"array","items":{"$ref":"#/definitions/BasicTransform"}},"tags":{"type":"array","items":{"$ref":"#/definitions/TagModel"}},"commentSymbol":{"type":"string"},"delimiter":{"type":"string"},"table":{"$ref":"#/definitions/TableTransform"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeGroupEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/EdgeGroup"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CampaignDiagnostics":{"type":"object","properties":{"callableContacts":{"$ref":"#/definitions/CallableContactsDiagnostic"},"queueUtilizationDiagnostic":{"$ref":"#/definitions/QueueUtilizationDiagnostic"},"outstandingInteractionsCount":{"type":"integer","format":"int32"}}},"EmailAddress":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"}}},"TrunkBase":{"type":"object","required":["trunkMetabase","trunkType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"trunkMetabase":{"description":"The meta-base this trunk is based on.","$ref":"#/definitions/UriReference"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"trunkType":{"type":"string","description":"The type of this trunk base.","enum":["EXTERNAL","PHONE","EDGE"]},"managed":{"type":"boolean","description":"Is this trunk being managed remotely.","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ResourceConditionNode":{"type":"object","properties":{"variableName":{"type":"string"},"conjunction":{"type":"string","enum":["AND","OR"]},"operator":{"type":"string","enum":["EQ","IN","GE","GT","LE","LT"]},"operands":{"type":"array","items":{"$ref":"#/definitions/ResourceConditionValue"}},"terms":{"type":"array","items":{"$ref":"#/definitions/ResourceConditionNode"}}}},"ExtensionEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Extension"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LockInfo":{"type":"object","properties":{"lockedBy":{"$ref":"#/definitions/UriReference"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateExpires":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"action":{"type":"string","enum":["UPDATE","DELETE","COPY","MOVE","REPLACE","THUMBNAIL","TEXT_EXTRACTION"]}}},"OutOfOffice":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"startDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"endDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"active":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AvailableTopic":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true}}},"PromptAssetEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/PromptAsset"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UnreadMetric":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}}},"AttributeFilterItem":{"type":"object","properties":{"id":{"type":"string"},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","CONTAINS"]},"values":{"type":"array","items":{"type":"string"}}}},"Organization":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"thirdPartyOrgId":{"type":"string"},"thirdPartyOrgName":{"type":"string"},"thirdPartyURI":{"type":"string","format":"uri"},"adminUsername":{"type":"string"},"adminPassword":{"type":"string"},"domain":{"type":"string"},"version":{"type":"integer","format":"int32"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"defaultSiteId":{"type":"string"},"deletable":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Discount":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"annualPrePay":{"type":"boolean","default":false},"discount":{"type":"string"},"maximum":{"type":"string"},"minimum":{"type":"string"},"productCategory":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SpreadsheetTransformEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ClientSpreadsheetTransform"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Facets":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"facetGroups":{"type":"array","items":{"$ref":"#/definitions/FacetGroup"}}}},"SortBy":{"type":"object","properties":{"name":{"type":"string"},"ascending":{"type":"boolean","default":false}}},"Conversation":{"type":"object","required":["participants","startTime"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"startTime":{"type":"string","format":"date-time","description":"The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"endTime":{"type":"string","format":"date-time","description":"The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"address":{"type":"string","description":"The address of the conversation as seen from an external participant. For phone calls this will be the DNIS for inbound calls and the ANI for outbound calls. For other media types this will be the address of the destination participant for inbound and the address of the initiating participant for outbound."},"participants":{"type":"array","description":"The list of all participants in the conversation.","items":{"$ref":"#/definitions/Participant"}},"conversationIds":{"type":"array","description":"A list of conversations to merge into this conversation to create a conference. This field is null except when being used to create a conference.","items":{"type":"string"}},"maxParticipants":{"type":"integer","format":"int32","description":"If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference."},"recordingState":{"type":"string","description":"On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings; otherwise indicates state of conversation recording.","enum":["ACTIVE","PAUSED","NONE"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Document"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RoutingStatus":{"type":"object","properties":{"userId":{"type":"string"},"status":{"type":"string","enum":["OFF_QUEUE","IDLE","INTERACTING","NOT_RESPONDING"]},"startTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"TableTransform":{"type":"object","properties":{"headerRow":{"type":"integer","format":"int32"},"firstData":{"type":"integer","format":"int32"},"headerReplaces":{"type":"array","items":{"$ref":"#/definitions/IndexedTransform"}},"columns":{"type":"array","items":{"$ref":"#/definitions/IndexedTransform"}},"unpivots":{"type":"array","items":{"$ref":"#/definitions/UnpivotColumns"}},"collapses":{"type":"array","items":{"$ref":"#/definitions/ColumnCollapse"}}}},"Okta":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"certificate":{"type":"string"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowBodyFormat":{"type":"object","properties":{"schemaUri":{"type":"string","format":"uri"},"description":{"type":"string"}}},"ResponseEntityList":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Response"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}},"description":"Query result list"},"ControlOptions":{"type":"object","properties":{"value":{"type":"string"},"label":{"type":"string"}}},"LocationEmergencyNumber":{"type":"object","properties":{"e164":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","description":"The type of emergency number.","enum":["default","elin"]}}},"DocumentUpdate":{"type":"object","properties":{"changeNumber":{"type":"integer","format":"int32"},"name":{"type":"string"},"read":{"type":"boolean","default":false},"addTags":{"type":"array","items":{"type":"string"}},"removeTags":{"type":"array","items":{"type":"string"}},"addTagIds":{"type":"array","items":{"type":"string"}},"removeTagIds":{"type":"array","items":{"type":"string"}},"updateAttributes":{"type":"array","items":{"$ref":"#/definitions/DocumentAttribute"}},"removeAttributes":{"type":"array","items":{"type":"string"}}}},"VoicemailMediaInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"mediaFileUri":{"type":"string","format":"uri"},"mediaImageUri":{"type":"string","format":"uri"}}},"FlowVersionConfigMetaDataEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/FlowVersionConfigMetaData"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ScheduleEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Schedule"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContentSortItem":{"type":"object","properties":{"name":{"type":"string"},"ascending":{"type":"boolean","default":false}}},"NumberPlan":{"type":"object","required":["matchType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"match":{"type":"string"},"normalizedFormat":{"type":"string"},"priority":{"type":"integer","format":"int32"},"numbers":{"type":"array","items":{"$ref":"#/definitions/Number"}},"digitLength":{"$ref":"#/definitions/DigitLength"},"classification":{"type":"string"},"matchType":{"type":"string","description":"The type of matching technique the number plan uses.","enum":["e164NumberList","numberList","digitLength","regex","intraCountryCode","interCountryCode"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrganizationPresence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"languageLabels":{"type":"object","additionalProperties":{"type":"string"}},"systemPresence":{"type":"string","enum":["AVAILABLE","AWAY","BUSY","OUT_OF_OFFICE","OFFLINE","ON_QUEUE","IDLE"]},"deactivated":{"type":"boolean","default":false},"createdBy":{"$ref":"#/definitions/User"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"$ref":"#/definitions/User"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MediaPolicies":{"type":"object","properties":{"callPolicy":{"description":"Conditions and actions for calls","$ref":"#/definitions/MediaPolicy"},"chatPolicy":{"description":"Conditions and actions for chats","$ref":"#/definitions/MediaPolicy"},"emailPolicy":{"description":"Conditions and actions for emails","$ref":"#/definitions/MediaPolicy"}}},"BatchItemBody":{"type":"object","properties":{"name":{"type":"string"}}},"EvaluatorActivityEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/EvaluatorActivity"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"VoicemailUserPolicy":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"alertTimeoutSeconds":{"type":"integer","format":"int32"},"minimumRecordingTimeSeconds":{"type":"integer","format":"int32"},"maximumRecordingTimeSeconds":{"type":"integer","format":"int32"},"unavailableMessageUri":{"type":"string","format":"uri"},"namePromptMessageUri":{"type":"string","format":"uri"},"fullMessageUri":{"type":"string","format":"uri"},"pin":{"type":"string"},"quotaSizeBytes":{"type":"integer","format":"int64"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"ReportRequest":{"type":"object","properties":{"pageNumber":{"type":"integer","format":"int32","description":"The pageNumber to get results from (EG If there are 100 results with a pageSize of 10 and pageNumber is 3 then 10 results will be returned starting with index #31"},"pageSize":{"type":"integer","format":"int32","description":"Number of entries to return/calculate per page."},"facetRequests":{"type":"array","description":"List of facet requests to generate summary views from the report result set (if any)","items":{"$ref":"#/definitions/FacetRequest"}},"sort":{"type":"array","description":"sort the results on a field(s)","items":{"$ref":"#/definitions/SortField"}},"filters":{"type":"array","description":"You can also restrict the request to particular field values and ranges","items":{"$ref":"#/definitions/FilterItem"}},"groupBy":{"type":"array","items":{"type":"string","enum":["USER","FLOW","QUEUE"]}}},"description":"Used to perform a search on various data stored in search engines"},"TwitterExpression":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation date for the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date the entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"isDispositioned":{"type":"boolean","description":"True once the expression has been dispositioned by an agent through the ACD process","default":false},"isNoise":{"type":"boolean","description":"Indicates if a user/agent found this expression to be undesirable","default":false},"gistener":{"description":"The Gistener that generated this expression","$ref":"#/definitions/Gistener"},"tweetId":{"type":"string","description":"Twitter: the tweet's unique id"},"text":{"type":"string","description":"Twitter: the tweets full text"},"tweetCreated":{"type":"string","format":"date-time","description":"Twitter: the date the tweet was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"isReply":{"type":"boolean","description":"Twitter: indicates this tweet as a reply to another tweet","default":false},"isRetweet":{"type":"boolean","description":"Twitter: indicates this tweet as a 'retweet' of another tweet","default":false},"retweetParentId":{"type":"string","description":"Twitter: when the expression is a retweet, this is Twitter's id of the original tweet"},"retweetCount":{"type":"integer","format":"int32","description":"Twitter: the number of times the parent tweet was retweeted - at the time this expression was created"},"isQuotedTweet":{"type":"boolean","description":"Twitter: indicates this expression as a quoted tweet (a tweet with an addendum as the primary text)","default":false},"quotedParentId":{"type":"string","description":"Twitter: when the expression is a quoted tweet, this is Twitter's id of the original tweet (may not be immediately functional)"},"userId":{"type":"string","description":"Twitter: the expressing user's Twitter id"},"userName":{"type":"string","description":"Twitter: the user's account name for the core service"},"userScreenName":{"type":"string","description":"Twitter: the user's custom 'branding' name (allowed to change over time)"},"userTweetCount":{"type":"integer","format":"int32","description":"Twitter: the number of times this user has tweeted (includes all forms of expression replies/quotes/retweets)"},"userFollowersCount":{"type":"integer","format":"int32","description":"Twitter: the number of followers this user has at the time of this expression"},"groupTags":{"type":"array","description":"The Group Tags applied by the generating Gistener","items":{"$ref":"#/definitions/GroupTag"}},"routed":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactList":{"type":"object","properties":{"id":{"type":"string"},"selfUri":{"type":"string"}}},"Annotation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string"},"location":{"type":"integer","format":"int64"},"durationMs":{"type":"integer","format":"int64"},"user":{"$ref":"#/definitions/User"},"description":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Flow":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["INBOUNDCALL","OUTBOUNDCALL","INQUEUECALL","SPEECH"]},"lockedUser":{"$ref":"#/definitions/UriReference"},"active":{"type":"boolean","default":false},"deleted":{"type":"boolean","default":false},"publishedVersion":{"$ref":"#/definitions/FlowVersion"},"checkedInVersion":{"$ref":"#/definitions/FlowVersion"},"savedVersion":{"$ref":"#/definitions/FlowVersion"},"system":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainResourceConditionNode":{"type":"object","properties":{"variableName":{"type":"string"},"operator":{"type":"string","enum":["EQ","IN","GE","GT","LE","LT"]},"operands":{"type":"array","items":{"$ref":"#/definitions/DomainResourceConditionValue"}},"conjunction":{"type":"string","enum":["AND","OR"]},"terms":{"type":"array","items":{"$ref":"#/definitions/DomainResourceConditionNode"}}}},"ContentFacetFilterItem":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST"]},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","CONTAINS"]},"values":{"type":"array","items":{"type":"string"}}}},"EdgeLogsJobFile":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"timeCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"timeModified":{"type":"string","format":"date-time","description":"The time this log file was last modified on the Edge. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"sizeBytes":{"type":"number","format":"double","description":"The size of this file in bytes."},"uploadStatus":{"type":"string","description":"The status of the upload of this file from the Edge to the cloud.  Use /upload to start an upload.","enum":["UPLOADING","NOT_UPLOADED","UPLOADED","ERROR_ON_UPLOAD"]},"edgePath":{"type":"string","format":"uri","description":"The path of this file on the Edge."},"downloadId":{"type":"string","description":"The download ID to use with the downloads API."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkItemSearchDetailsSearchResult":{"type":"object","properties":{"searchResults":{"description":"The actual results from the search","$ref":"#/definitions/LinkedEntityListingWorkItemSearchDetails"},"facetResults":{"type":"array","description":"The results from the facet requests for this search - note ALL facets will always be returned regardless of page size/starting pagenumber in the searchRequest","items":{"$ref":"#/definitions/FacetResult"}}},"description":"Contains the found elements of a search along with the facet result.  All facet results are always returned along with the searchResults regardless of page size/number."},"UserActionCategory":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkItemDetails":{"type":"object","required":["createTime","flowConfigId","flowCreateTime","flowExecId"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"workItemDefinition":{"$ref":"#/definitions/WorkItemDefinition"},"flowExecId":{"description":"The flow instance ID that created this WorkItem","$ref":"#/definitions/FlowExecId"},"flowConfigId":{"description":"The flow config ID that this workitem was created from.","$ref":"#/definitions/FlowConfigId"},"flowCreateTime":{"type":"string","format":"date-time","description":"The time the flow was started. (that created this workitem). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"createTime":{"type":"string","format":"date-time","description":"The time this workitem was started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"owner":{"description":"The user currently working on/has responsibility for this WorkItem.  May be null if no owner.","$ref":"#/definitions/User"},"offeredToUsers":{"type":"array","description":"List of users that this workItem is offered to.  May be null if only offered to queues.","items":{"$ref":"#/definitions/User"}},"offeredToQueues":{"type":"array","description":"List of queues that this workItem is offered to.  May be null if only offered to users.","items":{"$ref":"#/definitions/Queue"}},"title":{"type":"string","description":"The work item title"},"subtitle":{"type":"string","description":"The work item's subtitle - 2nd line/description"},"associatedDocuments":{"type":"array","description":"The documents associated with this workitem","items":{"$ref":"#/definitions/AssociatedDocument"}},"availableActions":{"description":"The actions that the user can take on this workitem (submit, transfer, etc).","$ref":"#/definitions/WorkItemActions"},"dataValueInfo":{"description":"The data items that provide values for any work item form elements, if applicable.","$ref":"#/definitions/DataValueInfo"},"workItemCache":{"description":"The data items in the current work item cache, if one exists.","$ref":"#/definitions/WorkItemCache"},"lastOfferedTime":{"type":"string","format":"date-time","description":"The time this work item was last offered to a user or queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"lastOwnershipUpdateTime":{"type":"string","format":"date-time","description":"The most recent time a user assumed ownership of a work item. This may be blank if the work item has no owner. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"currentTaskStartTime":{"type":"string","format":"date-time","description":"This is the time when the current task that started the work item was started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details about a WorkItem"},"ThirdPartySubscription":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"notes":{"type":"string"},"contractEffectiveDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PrimaryUserPresenceSource":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"primarySource":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContentAttributeFilterItem":{"type":"object","properties":{"id":{"type":"string"},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","CONTAINS"]},"values":{"type":"array","items":{"type":"string"}}}},"DIDPoolEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DIDPool"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PolicyErrors":{"type":"object","properties":{"policyErrorMessages":{"type":"array","items":{"$ref":"#/definitions/PolicyErrorMessage"}}}},"CallCommand":{"type":"object","properties":{"callNumber":{"type":"string"}}},"VoiceRateExtended":{"type":"object","required":["amendmentId","areaCode","currency","deletionMarker","effectiveDate","groupName","inboundTollFreeDurationIncrementSeconds","inboundTollFreeDurationMinimumSeconds","inboundTollFreeRate","inboundTolledDurationIncrementSeconds","inboundTolledDurationMinimumSeconds","inboundTolledRate","outboundDurationIncrementSeconds","outboundDurationMinimumSeconds","outboundRate","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"currency":{"type":"string","description":"The ISO 4217 currency code of the voice rate."},"amendmentId":{"type":"string","description":"The amendment Id of the voice rate."},"type":{"type":"string","description":"The voice rate type.","enum":["RATE_TOLL_FREE","RATE_TOLLED","OUTBOUND_INTERSTATE","OUTBOUND_INTRASTATE","OUTBOUND_LOCAL","EXTENDED"]},"effectiveDate":{"type":"string","format":"date-time","description":"The effective date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"groupName":{"type":"string","description":"The group containing this area code."},"areaCode":{"type":"string","description":"The area code."},"deletionMarker":{"type":"boolean","description":"The deletion marker.","default":false},"outboundRate":{"type":"number","description":"The outbound extended rate."},"outboundDurationMinimumSeconds":{"type":"integer","format":"int32","description":"The minimum duration charged in seconds."},"outboundDurationIncrementSeconds":{"type":"integer","format":"int32","description":"The billing duration increment in seconds."},"inboundTolledRate":{"type":"number","description":"The inbound tolled rate."},"inboundTolledDurationMinimumSeconds":{"type":"integer","format":"int32","description":"The minimum duration charged in seconds."},"inboundTolledDurationIncrementSeconds":{"type":"integer","format":"int32","description":"The billing duration increment in seconds."},"inboundTollFreeRate":{"type":"number","description":"The inbound toll-free rate."},"inboundTollFreeDurationMinimumSeconds":{"type":"integer","format":"int32","description":"The minimum duration charged in seconds."},"inboundTollFreeDurationIncrementSeconds":{"type":"integer","format":"int32","description":"The billing duration increment in seconds."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LineBaseEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/LineBase"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SocialExpression":{"type":"object","properties":{"state":{"type":"string","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","NONE"]},"id":{"type":"string"},"socialMediaId":{"type":"string"},"socialMediaHub":{"type":"string"},"socialUserName":{"type":"string"},"previewText":{"type":"string"},"recordingId":{"type":"string"},"segments":{"type":"array","items":{"$ref":"#/definitions/Segment"}},"held":{"type":"boolean","default":false},"disconnectType":{"type":"string","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"startHoldTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"connectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"UserConversationSummary":{"type":"object","properties":{"userId":{"type":"string"},"call":{"$ref":"#/definitions/MediaSummary"},"callback":{"$ref":"#/definitions/MediaSummary"},"email":{"$ref":"#/definitions/MediaSummary"},"chat":{"$ref":"#/definitions/MediaSummary"},"socialExpression":{"$ref":"#/definitions/MediaSummary"},"video":{"$ref":"#/definitions/MediaSummary"}}},"DomainEdgeSoftwareVersionDto":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"edgeVersion":{"type":"string"},"publishDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"edgeUri":{"type":"string","format":"uri"},"current":{"type":"boolean","default":false},"latestRelease":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AgentActivityEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/AgentActivity"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EvaluationFormEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/EvaluationForm"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Template":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"integer","format":"int32"},"level":{"type":"string","enum":["GLOBAL","ORGANIZATION","USER"]},"tags":{"type":"array","items":{"type":"string"}},"data":{"type":"object","additionalProperties":{"type":"object"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkItemSearchDetails":{"type":"object","properties":{"workItem":{"$ref":"#/definitions/WorkItemDetails"}},"description":"WorkItem entry found in result to a search."},"Reservation":{"type":"object","properties":{"id":{"type":"string"},"reservedTn":{"type":"string"},"reservationExpires":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"phoneNumberType":{"type":"string","description":"The type of phone number (eg us-domestic, toll-free, etc).","enum":["TOLL_FREE","CN_DOMESTIC","US_DOMESTIC"]}}},"PublishedResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","enum":["COMPLETED","FAILED","STARTED"]},"message":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GroupEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Group"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UsersEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/User"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportSchedule":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"quartzCronExpression":{"type":"string"},"nextFireTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"description":{"type":"string"},"timeZone":{"type":"string"},"timePeriod":{"type":"string"},"interval":{"type":"string","format":"date-time","description":"Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"reportFormat":{"type":"string"},"locale":{"type":"string"},"enabled":{"type":"boolean","default":false},"reportId":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"object"}},"lastRun":{"$ref":"#/definitions/ReportRunEntry"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GreetingOwner":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Facet":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"AutomateQueue":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"The description for the queue object."},"members":{"type":"array","description":"The members for the queue object.","uniqueItems":true,"items":{"$ref":"#/definitions/User"}},"lastUpdateTime":{"type":"string","format":"date-time","description":" The last time that the queue was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"lastUpdateUser":{"description":"The user who last performed an update.","$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserRecording":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"contentUri":{"type":"string","format":"uri"},"workspace":{"$ref":"#/definitions/UriReference"},"createdBy":{"$ref":"#/definitions/UriReference"},"conversation":{"$ref":"#/definitions/Conversation"},"contentLength":{"type":"integer","format":"int64"},"durationMilliseconds":{"type":"integer","format":"int64"},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}},"read":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TagQueryRequest":{"type":"object","properties":{"query":{"type":"string"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"}}},"TextTableTransformEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ClientTextTableTransform"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactSales":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"contactPhone":{"type":"string"},"country":{"type":"string"},"title":{"type":"string"},"message":{"type":"string"},"language":{"type":"string"},"productName":{"type":"string"},"quoteId":{"type":"string"},"industry":{"type":"string"},"estimatedUsers":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SheetSchema":{"type":"object","required":["DataRow","HeaderMappings","HeaderRow","RateType","SheetNumber"],"properties":{"HeaderRow":{"type":"integer","format":"int32","description":"Row number for the XLSX sheet's headers.  This is zero indexed (i.e. 0 is row 1)."},"DataRow":{"type":"integer","format":"int32","description":"Row number of the first line of data in the sheet.  This is zero indexed (i.e. 0 is row 1)"},"HeaderMappings":{"type":"object","description":"XLSX sheet header name to object name mappings. For example, \"ROUTE_TEL_PREFIX\" to \"Prefix\" might be one such mapping.","additionalProperties":{"type":"string"}},"RateType":{"type":"string","description":"Rate type for the sheet.","enum":["INTRASTATE","INTERSTATE","INTERNATIONAL"]},"SheetNumber":{"type":"integer","format":"int32","description":"Sheet number within the XLSX file.  This is zero indexed (i.e. 0 is page 1)."},"DateFormat":{"type":"string","description":"A date format that represents the date time stamp you want to parse. This is based on the reference time of Mon Jan 2 15:04:05 MST 2006. For example, if you had the date 13-OCT-2015, this parameter should be 02-Jan-2006. As another example, if you have the date 2014-09-20, this parameter should be 2006-01-02."}}},"FlowVersionConfigMetaData":{"type":"object","required":["flowDefinitionUri"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"versionSpecificComment":{"type":"string","description":"Checkin comment for this specific flow version."},"flowDefinitionUri":{"type":"string","description":"Uri location for the flow definition contents."},"createdByUser":{"description":"If known, the user who created this flow version.","$ref":"#/definitions/User"},"createdDate":{"type":"string","format":"date-time","description":"The date and time that the version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"version":{"type":"string","description":"Version of this flow config."}},"description":"Details about a specific Flow Definition version."},"UnpivotColumns":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/definitions/IndexedTransform"}}}},"DomainOrganizationRole":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"defaultRoleId":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"licenses":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"permissionPolicies":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"code":{"type":"string"},"userCount":{"type":"integer","format":"int32"},"roleNeedsUpdate":{"type":"boolean","default":false},"default":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserParam":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"LanguageEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Language"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PhysicalInterfaceEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DomainPhysicalInterface"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OAuthClientEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OAuthClient"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Value":{"type":"object","properties":{"stringItems":{"type":"array","items":{"type":"string"}},"integerItems":{"type":"array","items":{"type":"string"}},"realItems":{"type":"array","items":{"type":"string"}},"dateItems":{"type":"array","items":{"type":"string","format":"date-time"}},"userItems":{"type":"array","items":{"$ref":"#/definitions/User"}},"queueItems":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"dataItems":{"type":"array","items":{"$ref":"#/definitions/SubDataItem"}}}},"CallableContactsDiagnostic":{"type":"object","properties":{"dncLists":{"type":"array","items":{"$ref":"#/definitions/UriReference"}},"callableTimeSet":{"$ref":"#/definitions/UriReference"},"ruleSets":{"type":"array","items":{"$ref":"#/definitions/UriReference"}}}},"Library":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"integer","format":"int32"},"createdBy":{"$ref":"#/definitions/User"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SpreadsheetTransform":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"restEndpoint":{"$ref":"#/definitions/TransformEndpoint"},"filenameTransforms":{"type":"array","items":{"$ref":"#/definitions/BasicTransform"}},"tags":{"type":"array","items":{"$ref":"#/definitions/TagModel"}},"sheetNameTransforms":{"type":"array","items":{"$ref":"#/definitions/IndexedTransform"}},"sheets":{"type":"array","items":{"$ref":"#/definitions/SheetTransform"}},"clientTransformModel":{"$ref":"#/definitions/ClientSpreadsheetTransform"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Detail":{"type":"object","properties":{"errorCode":{"type":"string"},"fieldName":{"type":"string"},"entityId":{"type":"string"},"entityName":{"type":"string"}}},"UserRecordingEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/UserRecording"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserActionMetadata":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"category":{"type":"string"},"deprecated":{"type":"boolean","default":false},"description":{"type":"string"},"published":{"type":"boolean","default":false},"tags":{"type":"array","items":{"type":"string"}},"helpLink":{"type":"string"},"requests":{"type":"array","items":{"$ref":"#/definitions/UserActionMetadataRequest"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Destination":{"type":"object","required":["address"],"properties":{"accountCodeDigits":{"type":"string"},"postConnectDigits":{"type":"string"},"address":{"type":"string","description":"Address or phone number."},"name":{"type":"string"},"userId":{"type":"string"},"queueId":{"type":"string"}}},"ResponseEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Response"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OAuthClient":{"type":"object","required":["authorizedGrantTypes","name","registeredRedirectUri"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the OAuth client."},"accessTokenValiditySeconds":{"type":"integer","format":"int64","description":"The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied."},"authorizedGrantTypes":{"type":"array","description":"The OAuth Grant/Client type supported by this client.","items":{"type":"string","enum":["CODE","TOKEN","SAML2BEARER","PASSWORD","CLIENT_CREDENTIALS"]}},"description":{"type":"string"},"registeredRedirectUri":{"type":"array","description":"List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback","items":{"type":"string","format":"uri"}},"secret":{"type":"string","description":"System created secret assigned to this client. Secrets are required for code authorization grants."},"roleIds":{"type":"array","description":"Roles assigned to this client. Roles only apply to clients using the client_credential grant","uniqueItems":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationForm":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"published":{"type":"boolean","default":false},"contextId":{"type":"string"},"questionGroups":{"type":"array","items":{"$ref":"#/definitions/QuestionGroup"}},"publishedVersions":{"$ref":"#/definitions/DomainEntityListingEvaluationForm"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserActionMetadataRequest":{"type":"object","properties":{"format":{"type":"string"},"method":{"type":"string"},"inputSchemaUri":{"type":"string"},"successSchemaUri":{"type":"string"},"inputSchema":{"type":"object"},"successSchema":{"type":"object"}}},"MediaResult":{"type":"object","properties":{"waveUri":{"type":"string"},"mediaUri":{"type":"string"},"waveformData":{"type":"array","items":{"type":"number","format":"float"}}}},"DomainPhysicalInterface":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"edgeUri":{"type":"string","format":"uri"},"friendlyName":{"type":"string"},"hardwareAddress":{"type":"string"},"portLabel":{"type":"string"},"physicalCapabilities":{"$ref":"#/definitions/DomainPhysicalCapabilities"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ResponseSet":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"integer","format":"int32"},"responses":{"type":"object","additionalProperties":{"$ref":"#/definitions/Reaction"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowHistoryItem":{"type":"object","required":["historyEventTime","historyEventType","success"],"properties":{"historyEventTime":{"type":"string","format":"date-time","description":"The time when the history item occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"state":{"description":"The State sequence that applies to the history event, if applicable.","$ref":"#/definitions/FlowState"},"workItem":{"description":"Information about the work item associated with the history event, if applicable.","$ref":"#/definitions/WorkItem"},"user":{"description":"The user associated with this history event, if applicable.","$ref":"#/definitions/User"},"queue":{"description":"The queue associated with this history event, if applicable.","$ref":"#/definitions/Queue"},"historyEventData":{"type":"array","description":"Data elements associated with this history event.","items":{"$ref":"#/definitions/DataItem"}},"historyEventType":{"type":"string","description":"The type of the history event being reported.","enum":["FLOW_INSTANCE_START","FLOW_INSTANCE_GOTO","FLOW_INSTANCE_TERMINATE","FLOW_INSTANCE_END","TASK_INSTANCE_START","TASK_INSTANCE_END","WORK_ITEM_INSTANCE_SAVE","WORK_ITEM_INSTANCE_ACQUIRE","WORK_ITEM_INSTANCE_SUBMIT","WORK_ITEM_INSTANCE_OFFER","WORK_ITEM_INSTANCE_REASSIGN","FLOW_INSTANCE_ERROR","FLOW_INSTANCE_RETRY"]},"success":{"type":"boolean","description":"Whether or not the flow item was successful (if a 'notification' event this will default to true)","default":false}},"description":"Information about one flow history item"},"GreetingAudioFile":{"type":"object","properties":{"durationMilliseconds":{"type":"integer","format":"int64"},"sizeBytes":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri"}}},"FacetGroup":{"type":"object","properties":{"name":{"type":"string"},"count":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/definitions/FacetItem"}}}},"UserPresenceEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/UserPresence"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Phone":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"edgeGroup":{"$ref":"#/definitions/UriReference"},"site":{"$ref":"#/definitions/UriReference"},"phoneBaseSettings":{"$ref":"#/definitions/UriReference"},"lineBaseSettings":{"$ref":"#/definitions/UriReference"},"phoneMetaBase":{"$ref":"#/definitions/UriReference"},"lines":{"type":"array","items":{"$ref":"#/definitions/Line"}},"status":{"description":"The status of the phone and lines from the primary Edge.","$ref":"#/definitions/PhoneStatus"},"secondaryStatus":{"description":"The status of the phone and lines from the secondary Edge.","$ref":"#/definitions/PhoneStatus"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"capabilities":{"$ref":"#/definitions/PhoneCapabilities"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Gateway":{"type":"object","properties":{"id":{"type":"string"},"ip":{"type":"string"},"port":{"type":"integer","format":"int32"}}},"DomainNetworkCommandResponse":{"type":"object","properties":{"correlationId":{"type":"string"},"commandName":{"type":"string"},"acknowledged":{"type":"boolean","default":false},"errorInfo":{"$ref":"#/definitions/ErrorDetails"}}},"UserLicenseAssignment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"licenseId":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"InboundRouteEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/InboundRoute"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowInputData":{"type":"object","properties":{"linkedDocumentIds":{"type":"array","description":"A list of document IDs to link with the new flow instance.","items":{"type":"string"}}},"description":"launch parameters or initializations for variables in the flow."},"VendorConnectionRequest":{"type":"object","properties":{"publisher":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}},"DeleteRetention":{"type":"object","properties":{"days":{"type":"integer","format":"int32"}}},"QueryRequest":{"type":"object","properties":{"queryPhrase":{"type":"string"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"facetNameRequests":{"type":"array","items":{"type":"string"}},"sort":{"type":"array","items":{"$ref":"#/definitions/SortItem"}},"filters":{"type":"array","items":{"$ref":"#/definitions/FacetFilterItem"}},"attributeFilters":{"type":"array","items":{"$ref":"#/definitions/AttributeFilterItem"}}}},"FaxSummary":{"type":"object","properties":{"readCount":{"type":"integer","format":"int32"},"unreadCount":{"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int32"}}},"DialerPlaceCallCommand":{"type":"object","properties":{"callId":{"type":"string"},"phoneNumber":{"type":"string"}}},"BatchReply":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/BatchReplyItem"}}}},"Calibration":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"calibrator":{"$ref":"#/definitions/User"},"agent":{"$ref":"#/definitions/User"},"conversation":{"$ref":"#/definitions/Conversation"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"contextId":{"type":"string"},"averageScore":{"type":"integer","format":"int32"},"highScore":{"type":"integer","format":"int32"},"lowScore":{"type":"integer","format":"int32"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"evaluations":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"scoringIndex":{"$ref":"#/definitions/Evaluation"},"expertEvaluator":{"$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserPresence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"source":{"type":"string","description":"Represents the source where the Presence was set. Some examples are: PURECLOUD, LYNC, OUTLOOK, etc."},"presenceDefinition":{"$ref":"#/definitions/OrganizationPresence"},"message":{"type":"string"},"modifiedBy":{"$ref":"#/definitions/User"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowPublish":{"type":"object","required":["flowConfigVersionSource"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"flowConfigVersionSource":{"type":"string","description":"Source version that the flow was published from."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"version":{"type":"string","description":"Version of this flow config."}},"description":"Returned upon a successful publish request."},"CalibrationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Calibration"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Trace":{"type":"object","properties":{"topic":{"type":"string"},"timestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"level":{"type":"string","enum":["ERROR","WARN","INFO","DEBUG"]},"message":{"type":"string"},"details":{"type":"object"},"timestampString":{"type":"string"},"detailsString":{"type":"string"}}},"ProgressModel":{"type":"object","required":["iterationsDone","iterationsInPhase","phase"],"properties":{"phase":{"type":"string","description":"Human readable progress"},"iterationsDone":{"type":"integer","format":"int32","description":"Number of iterations performed"},"iterationsInPhase":{"type":"integer","format":"int32","description":"Approximate number of iterations to perform in this phase"}}},"AutomateQueueMember":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CommandStatusEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/CommandStatus"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Callback":{"type":"object","properties":{"state":{"type":"string","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","NONE"]},"id":{"type":"string"},"segments":{"type":"array","items":{"$ref":"#/definitions/Segment"}},"direction":{"type":"string","enum":["INBOUND","OUTBOUND"]},"held":{"type":"boolean","default":false},"disconnectType":{"type":"string","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"startHoldTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dialerPreview":{"$ref":"#/definitions/DialerPreview"},"callbackNumbers":{"type":"array","items":{"type":"string"}},"callbackUserName":{"type":"string"},"scriptId":{"type":"string"},"skipEnabled":{"type":"boolean","default":false},"timeoutSeconds":{"type":"integer","format":"int32"},"connectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"ContractJob":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"contract":{"$ref":"#/definitions/Contract"},"status":{"type":"string","description":"The current status of the job.","enum":["Processing","Completed","Failed"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowTerminateRequest":{"type":"object","properties":{"reason":{"type":"string","description":"Reason code for a termination."}},"description":"Passed into a terminate command to customize the termination action."},"TraceList":{"type":"object","properties":{"app":{"$ref":"#/definitions/App"},"traces":{"type":"array","items":{"$ref":"#/definitions/Trace"}}}},"MetricThreshold":{"type":"object","properties":{"op":{"type":"string","enum":["GT","GE","LT","LE","EQ","NE"]},"value":{"type":"number","format":"double"}}},"FlowDetails":{"type":"object","required":["flowConfigId","launchTime","launchType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"flowConfigId":{"description":"The FlowConfigId that was used to launch this flow.","$ref":"#/definitions/FlowConfigId"},"launchTime":{"type":"string","format":"date-time","description":"The time the flow was launched. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"launchType":{"type":"string","description":"The launch mode for this flow instance.","enum":["UNKNOWN","NORMAL","TEST","AUTOMATIC"]},"launchedBy":{"description":"The user who launched the flow, if the flow was launched as the result of that user's action.","$ref":"#/definitions/User"},"status":{"type":"string","description":"The flow's running status, which indicates whether the flow is running normally or completed, etc.","enum":["UNKNOWN","RUNNING","ERROR","TERMINATED","COMPLETED"]},"associatedDocuments":{"type":"array","description":"The documents associated with this flow.","items":{"$ref":"#/definitions/AssociatedDocument"}},"flowCompletionTime":{"type":"string","format":"date-time","description":"The time the flow completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"flowCompletionReason":{"type":"string","description":"The completion reason set at the flow completion time, if applicable."},"flowErrorInfo":{"description":"Additional information if the flow is in error","$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details about the current state of a Flow Instance"},"OrgLicenseAssignment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"licenseId":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VoiceXmlOperation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","enum":["GOTO","CALL_AND_RETURN"]},"method":{"type":"string","enum":["GET","PUT","POST","DELETE"]},"encoding":{"type":"string","enum":["MULTIPART_FORM_DATA","FORM_URL_ENCODED","JSON"]},"description":{"type":"string"},"uri":{"type":"string"},"inputs":{"type":"string"},"outputs":{"type":"string"},"fetchAudio":{"type":"string"},"timeoutMS":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Edge":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"interfaces":{"type":"array","items":{"$ref":"#/definitions/EdgeInterface"}},"make":{"type":"string"},"model":{"type":"string"},"apiVersion":{"type":"string"},"softwareVersion":{"type":"string"},"softwareVersionTimestamp":{"type":"string"},"softwareVersionPlatform":{"type":"string"},"softwareVersionConfiguration":{"type":"string"},"fullSoftwareVersion":{"type":"string"},"pairingId":{"type":"string"},"fingerprint":{"type":"string"},"fingerprintHint":{"type":"string"},"currentVersion":{"type":"string"},"stagedVersion":{"type":"string"},"patch":{"type":"string"},"statusCode":{"type":"string","enum":["NEW","AWAITING_CONNECTION","AWAITING_FINGERPRINT","AWAITING_FINGERPRINT_VERIFICATION","FINGERPRINT_VERIFIED","AWAITING_BOOTSTRAP","ACTIVE","INACTIVE","RMA","UNPAIRING","UNPAIRED"]},"edgeGroup":{"$ref":"#/definitions/EdgeGroup"},"site":{"$ref":"#/definitions/UriReference"},"softwareStatus":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"},"onlineStatus":{"type":"string","enum":["ONLINE","OFFLINE"]},"serialNumber":{"type":"string"},"physicalEdge":{"type":"boolean","default":false},"managed":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ValidateAddressResponse":{"type":"object","properties":{"valid":{"type":"boolean","default":false},"response":{"$ref":"#/definitions/Response"}}},"Workspace":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","enum":["USER","GROUP"]},"isCurrentUserWorkspace":{"type":"boolean","default":false},"user":{"$ref":"#/definitions/UriReference"},"bucket":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"summary":{"$ref":"#/definitions/WorkspaceSummary"},"acl":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SessionEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Session"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ValidateAddressRequest":{"type":"object","properties":{"address":{"$ref":"#/definitions/Address"}}},"App":{"type":"object","properties":{"appId":{"type":"string"},"appVersion":{"type":"string"}}},"NocSupport":{"type":"object","properties":{"phone":{"type":"string"},"email":{"type":"string"}}},"SchemaCategoryEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/SchemaCategory"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SheetTransform":{"type":"object","properties":{"sheet":{"type":"integer","format":"int32"},"sheetName":{"type":"string"},"table":{"$ref":"#/definitions/TableTransform"}}},"CertificateDetails":{"type":"object","properties":{"issuer":{"type":"string","description":"Information about the issuer of the certificate.  The value of this property is a comma separated key=value format.  Each key is one of the attribute names supported by X.500."},"subject":{"type":"string","description":"Information about the subject of the certificate.  The value of this property is a comma separated key=value format.  Each key is one of the attribute names supported by X.500."},"expirationDate":{"type":"string","format":"date-time","description":"The expiration date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"issueDate":{"type":"string","format":"date-time","description":"The issue date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"expired":{"type":"boolean","description":"True if the certificate is expired, false otherwise.","default":false},"signatureValid":{"type":"boolean","default":false},"valid":{"type":"boolean","default":false}},"description":"Represents the details of a parsed certificate."},"RestErrorDetail":{"type":"object","properties":{"error":{"type":"string"},"details":{"type":"string"}}},"Document":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"changeNumber":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateUploaded":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"contentUri":{"type":"string","format":"uri"},"workspace":{"$ref":"#/definitions/UriReference"},"createdBy":{"$ref":"#/definitions/UriReference"},"uploadedBy":{"$ref":"#/definitions/UriReference"},"contentType":{"type":"string"},"contentLength":{"type":"integer","format":"int64"},"systemType":{"type":"string","enum":["DOCUMENT","FAX","RECORDING"]},"filename":{"type":"string"},"pageCount":{"type":"integer","format":"int64"},"read":{"type":"boolean","default":false},"callerAddress":{"type":"string"},"receiverAddress":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"tagValues":{"type":"array","items":{"$ref":"#/definitions/TagValue"}},"attributes":{"type":"array","items":{"$ref":"#/definitions/DocumentAttribute"}},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}},"uploadStatus":{"$ref":"#/definitions/UriReference"},"uploadDestinationUri":{"type":"string","format":"uri"},"uploadMethod":{"type":"string","enum":["SINGLE_PUT","MULTIPART_POST"]},"lockInfo":{"$ref":"#/definitions/LockInfo"},"acl":{"type":"array","description":"A list of permitted action rights for the user making the request","items":{"type":"string"}},"sharingStatus":{"type":"string","enum":["NONE","LIMITED","PUBLIC"]},"sharingUri":{"type":"string","format":"uri"},"downloadSharingUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"alertable":{"type":"boolean","default":false},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"type":{"type":"string","enum":["USER","SYSTEM"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IndexedTransform":{"type":"object","properties":{"replaces":{"type":"array","items":{"$ref":"#/definitions/TransformLens"}},"entityPath":{"type":"array","items":{"type":"string"}},"index":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"Endpoint":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"count":{"type":"integer","format":"int32"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"schema":{"$ref":"#/definitions/UriReference"},"enabled":{"type":"boolean","default":false},"site":{"$ref":"#/definitions/UriReference"},"dids":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExtensionPool":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"startNumber":{"type":"string","description":"The starting phone number for the range of this Extension pool. Must be in E.164 format"},"endNumber":{"type":"string","description":"The ending phone number for the range of this Extension pool. Must be in E.164 format"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DeltaDocument":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"filename":{"type":"string"},"contentType":{"type":"string"},"contentLengthBytes":{"type":"integer","format":"int64"},"operation":{"type":"string","enum":["CREATED","UPDATED","REPLACED","DELETED"]},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"AlertEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Alert"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmailMessageListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/EmailMessage"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TermAttribute":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST"]}}},"InboundDomain":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"mxRecordStatus":{"type":"string","enum":["VALID","INVALID","NOT_AVAILABLE"]},"subDomain":{"type":"boolean","description":"Indicates if this a PureCloud sub-domain.  If true, then the appropriate DNS records are created for sending/receiving email.","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"HIPAAConfig":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enableIdleTokenTimeout":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FaxDocumentEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/FaxDocument"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactCallbackRequest":{"type":"object","properties":{"campaignId":{"type":"string"},"contactListId":{"type":"string"},"contactId":{"type":"string"},"phoneColumn":{"type":"string"},"schedule":{"type":"string"}}},"ResponseSetEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ResponseSet"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PhoneStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"operationalStatus":{"type":"string","description":"The Operational Status of this phone","enum":["OPERATIONAL","DEGRADED","OFFLINE"]},"edgesStatus":{"type":"string","description":"The status of the primary or secondary Edges assigned to the phone lines.","enum":["IN_SERVICE","MIXED_SERVICE","OUT_OF_SERVICE","NO_EDGES"]},"provision":{"description":"Provision information for this phone","$ref":"#/definitions/ProvisionInfo"},"lineStatuses":{"type":"array","description":"A list of LineStatus information for each of the lines of this phone","items":{"$ref":"#/definitions/LineStatus"}},"phoneAssignmentToEdgeType":{"type":"string","description":"The phone status's edge assignment type.","enum":["PRIMARY","SECONDARY"]},"edge":{"description":"The URI of the edge that provided this status information.","$ref":"#/definitions/UriReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DIDEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DID"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Tier":{"type":"object","properties":{"currency":{"type":"string"},"price":{"type":"number"}}},"ServiceContext":{"type":"object","properties":{"name":{"type":"string"}}},"UserSkill":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"proficiency":{"type":"number","format":"double"},"skillId":{"type":"string"},"active":{"type":"boolean","default":false}}},"Dependency":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"string"},"type":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BRIDGEACTION","COMPOSERSCRIPT","CONTACTLIST","INBOUNDCALLFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","OUTBOUNDCALLFLOW","QUEUE","SYSTEMPROMPT","USER","USERPROMPT","VOICEXML"]},"deleted":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ArchiveRetention":{"type":"object","properties":{"days":{"type":"integer","format":"int32"},"storageMedium":{"type":"string","enum":["CLOUDARCHIVE"]}}},"CampaignProgress":{"type":"object","properties":{"campaign":{"$ref":"#/definitions/UriReference"},"contactList":{"$ref":"#/definitions/UriReference"},"numberOfContactsCalled":{"type":"integer","format":"int64"},"totalNumberOfContacts":{"type":"integer","format":"int64"},"percentage":{"type":"integer","format":"int64"}}},"QueueUtilizationDiagnostic":{"type":"object","properties":{"queue":{"$ref":"#/definitions/UriReference"},"usersInQueue":{"type":"integer","format":"int32"},"activeUsersInQueue":{"type":"integer","format":"int32"},"usersOnQueue":{"type":"integer","format":"int32"},"usersNotUtilized":{"type":"integer","format":"int32"},"usersOnQueueWithStation":{"type":"integer","format":"int32"},"usersOnACampaignCall":{"type":"integer","format":"int32"},"usersOnANonCampaignCall":{"type":"integer","format":"int32"}}},"DomainNetworkAddress":{"type":"object","properties":{"type":{"type":"string"},"address":{"type":"string"},"persistent":{"type":"boolean","default":false},"family":{"type":"integer","format":"int32"}}},"DomainPermissionCollection":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"domain":{"type":"string"},"permissionMap":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/DomainPermission"}}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Participant":{"type":"object","properties":{"id":{"type":"string"},"startTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"endTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"connectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"name":{"type":"string"},"userUri":{"type":"string"},"userId":{"type":"string"},"queueId":{"type":"string"},"groupId":{"type":"string"},"queueName":{"type":"string"},"purpose":{"type":"string"},"participantType":{"type":"string"},"consultParticipantId":{"type":"string"},"address":{"type":"string"},"ani":{"type":"string"},"dnis":{"type":"string"},"locale":{"type":"string"},"wrapupRequired":{"type":"boolean","default":false},"wrapupExpected":{"type":"boolean","default":false},"wrapupPrompt":{"type":"string","enum":["MANDATORY","OPTIONAL","TIMEOUT","FORCED_TIMEOUT"]},"wrapupTimeoutMs":{"type":"integer","format":"int32"},"wrapupSkipped":{"type":"boolean","default":false},"wrapup":{"$ref":"#/definitions/Wrapup"},"monitoredParticipantId":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"calls":{"type":"array","items":{"$ref":"#/definitions/Call"}},"callbacks":{"type":"array","items":{"$ref":"#/definitions/Callback"}},"chats":{"type":"array","items":{"$ref":"#/definitions/Chat"}},"emails":{"type":"array","items":{"$ref":"#/definitions/Email"}},"socialExpressions":{"type":"array","items":{"$ref":"#/definitions/SocialExpression"}},"videos":{"type":"array","items":{"$ref":"#/definitions/Video"}},"evaluations":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}}}},"DefaultGreetingList":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"owner":{"$ref":"#/definitions/GreetingOwner"},"ownerType":{"type":"string","enum":["USER","ORGANIZATION"]},"greetings":{"type":"object","additionalProperties":{"$ref":"#/definitions/Greeting"}},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"createdBy":{"type":"string","format":"uri"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhoneMetaBaseEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Metabase"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ParsedCertificate":{"type":"object","properties":{"certificateDetails":{"type":"array","description":"The details of the certificates that were parsed correctly.","items":{"$ref":"#/definitions/CertificateDetails"}}},"description":"Represents the parsed certificate information."},"MaxParticipants":{"type":"object","properties":{"maxParticipants":{"type":"integer","format":"int32"}}},"ContactListEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ContactList"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FacetResult":{"type":"object","properties":{"requestName":{"type":"string","description":"This was the name passed in as part of the facetRequest"},"requestFieldName":{"type":"string","description":"The field name that the facet was requested for."},"fieldType":{"type":"string","description":"data type of the field being returned (if this is a mixed field this will be unknown)","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST","GROUP"]},"requestType":{"type":"string","description":"the facet request type that was made.","enum":["TERM","RANGE"]},"results":{"type":"array","items":{"$ref":"#/definitions/FacetResultItem"}}},"description":"Used as part of the searchResult to return facet results to the caller"},"HardwareRate":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"partNumber":{"type":"string"},"rate":{"$ref":"#/definitions/Rate"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SequenceSchedule":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"integer","format":"int32"},"intervals":{"type":"array","items":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"end":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}}},"timeZone":{"type":"string"},"sequence":{"$ref":"#/definitions/UriReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Group":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"memberCount":{"type":"integer","format":"int64"},"groupType":{"type":"string","enum":["OFFICIAL","DISTRIBUTION_GROUP"]},"groupImages":{"$ref":"#/definitions/GroupImages"},"groupState":{"type":"string","enum":["ACTIVE","INACTIVE","DELETED"]},"version":{"type":"number","format":"double"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainEntityListingEvaluationForm":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/EvaluationForm"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserImage":{"type":"object","properties":{"resolution":{"type":"string"},"imageUri":{"type":"string"}}},"Attribute":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"integer","format":"int32"},"description":{"type":"string"},"createdBy":{"$ref":"#/definitions/UriReference"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"$ref":"#/definitions/UriReference"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainEntityListingQueryResult":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/QueryResult"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ErrorDetails":{"type":"object","properties":{"status":{"type":"integer","format":"int32"},"message":{"type":"string"},"messageWithParams":{"type":"string"},"messageParams":{"type":"object","additionalProperties":{"type":"string"}},"code":{"type":"string"},"contextId":{"type":"string"},"nested":{"$ref":"#/definitions/ErrorDetails"},"details":{"type":"string","format":"uri"}}},"TwitterExpressionBuffer":{"type":"object","properties":{"bufferContent":{"type":"array","description":"The list of TwitterExpressions currently in the buffer.","items":{"$ref":"#/definitions/TwitterExpression"}}}},"CallableTimeSet":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"integer","format":"int32"},"callableTimes":{"type":"array","items":{"$ref":"#/definitions/CallableTime"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ResponseQueryRequest":{"type":"object","properties":{"queryPhrase":{"type":"string","description":"Query phrase to search response text and name. If not set will match all."},"pageSize":{"type":"integer","format":"int32","description":"The maximum number of hits to return. Default: 25, Maximum: 500."},"filters":{"type":"array","description":"Filter the query results.","items":{"$ref":"#/definitions/Filter"}}},"description":"Used to query for responses"},"DurationCondition":{"type":"object","properties":{"durationTarget":{"type":"string","enum":["DURATION","DURATION_RANGE"]},"durationOperator":{"type":"string"},"durationRange":{"type":"string"}}},"CsvSchema":{"type":"object","required":["DataRow","HeaderMappings","HeaderRow","Name","RateType"],"properties":{"CarrierId":{"type":"string","description":"Carrier ID associated with this CSV schema.","readOnly":true},"HeaderRow":{"type":"integer","format":"int32","description":"Row number for the CSV's headers.  This is zero indexed (i.e. 0 is row 1)."},"DataRow":{"type":"integer","format":"int32","description":"Row number of the first line of data.  This is zero indexed (i.e. 0 is row 1)."},"HeaderMappings":{"type":"object","description":"CSV header name to object name mappings. For example, \"ROUTE_TEL_PREFIX\" to \"Prefix\" might be one such mapping.","additionalProperties":{"type":"string"}},"RateType":{"type":"string","description":"Rate type for the sheet.","enum":["INTRASTATE","INTERSTATE","INTERNATIONAL"]},"Name":{"type":"string","description":"Human readable name for schema."},"DateFormat":{"type":"string","description":"A date format that represents the date time stamp you want to parse. This is based on the reference time of Mon Jan 2 15:04:05 MST 2006. For example, if you had the date 13-OCT-2015, this parameter should be 02-Jan-2006. As another example, if you have the date 2014-09-20, this parameter should be 2006-01-02."}}},"ConversationHistoricalQueryRequestFilter":{"type":"object","required":["operator","target","values"],"properties":{"target":{"type":"string","example":"interval","description":"Filter target","enum":["active","agentId","ani","connectedOnly","dialerCampaignId","disconnectType","dnis","duration","interval","freeText","mediaType","qualityEvaluationAgent","qualityEvaluationCriticalScore","qualityEvaluationForm","qualityEvaluationScore","qualityEvaluator","queueId","purpose","recordingRestored","wrapUpCode"]},"operator":{"type":"string","description":"Filter operator. For target 'interval' allowable values are '=', 'between', '<=', 'before', '>=', 'after'. For targets 'active', 'agentId', 'connectedOnly', 'dialerCampaignId', 'disconnectType', 'mediaType', 'purpose', 'qualityEvaluationAgent', 'qualityEvaluationForm', 'qualityEvaluator', 'queueId', 'wrapUpCode' allowable value is '='. For target 'duration' allowable values are '=', '<', '<=', '>', '>='. For targets 'ani', 'dnis', 'freeText' allowable value is 'contains'. For targets 'recordingRestored', 'qualityEvaluationCriticalScore', ', qualityEvaluationScore' no operator is required"},"values":{"type":"array","description":"Filter values. For target 'interval' with operators '=' or 'between', only 1 value is allowed in the form of 2 ISO-8601 dates separated by a '/' with no spaces. For target 'interval' with operators '<=', 'before', '>=', 'after', only 1 value is allowed in the form of 1 ISO-8601 date. For targets 'agentId', 'dialerCampaignId', 'qualityEvaluationAgent', 'qualityEvaluationForm', 'qualityEvaluator', 'queueId', 'wrapUpCode' multiple values are allowed. All values are UUIDs. For target 'disconnectType' multiple values are allowed. Values can be one of 'TRANSFER', 'CLIENT', 'REMOTE'. For target 'mediaType' multiple values are allowed. Values can be one of 'VOICE', 'CHAT', 'EMAIL'.For target 'purpose' multiple values are allowed. For targets 'active', 'connectedOnly'1 value is required and it must be either 'true' or 'false'. For target 'duration' 2 values are required for operator '='. For all other operators, 1 value is required. For targets 'ani', 'dnis', 'freeText' only a single value is allowed. For targets 'recordingRestored', 'qualityEvaluationCriticalScore', ', qualityEvaluationScore' no values are required.","items":{"type":"string"}}},"description":"Historical conversation request filter"},"ContactListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalContact"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Flow"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ChannelTopic":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AgentEvaluatorActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"agent":{"$ref":"#/definitions/User"},"evaluator":{"$ref":"#/definitions/User"},"numEvaluations":{"type":"integer","format":"int32"},"averageEvaluationScore":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConsumingResourcesEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportRunEntryEntityDomainListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ReportRunEntry"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WorkItemCommand":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"}}},"ClientTransformModel":{"type":"object","properties":{"id":{"type":"string"},"endpointId":{"type":"string"},"filenameReplaces":{"type":"array","items":{"$ref":"#/definitions/BasicTransform"}},"tags":{"type":"array","items":{"$ref":"#/definitions/TagModel"}},"name":{"type":"string"}}},"UserActionMetadataEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"entities":{"type":"array","items":{"$ref":"#/definitions/UserActionMetadata"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactSalesResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"emailBody":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GeolocationSettings":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Call":{"type":"object","properties":{"state":{"type":"string","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","CONVERTING","UPLOADING","TRANSMITTING","NONE"]},"id":{"type":"string"},"direction":{"type":"string","enum":["INBOUND","OUTBOUND"]},"recording":{"type":"boolean","default":false},"recordingState":{"type":"string","enum":["NONE","ACTIVE","PAUSED"]},"muted":{"type":"boolean","default":false},"confined":{"type":"boolean","default":false},"held":{"type":"boolean","default":false},"recordingId":{"type":"string"},"segments":{"type":"array","items":{"$ref":"#/definitions/Segment"}},"errorInfo":{"$ref":"#/definitions/ErrorBody"},"disconnectType":{"type":"string","enum":["ENDPOINT","CLIENT","SYSTEM","TIMEOUT","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"startHoldTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"documentId":{"type":"string"},"self":{"$ref":"#/definitions/Address"},"other":{"$ref":"#/definitions/Address"},"connectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"PenetrationRate":{"type":"object","properties":{"numberOfContactsCalled":{"type":"integer","format":"int64"},"totalNumberOfContacts":{"type":"integer","format":"int64"},"percentage":{"type":"integer","format":"int64"},"penetrationRateId":{"$ref":"#/definitions/PenetrationRateId"}}},"Ticker":{"type":"object","required":["exchange","symbol"],"properties":{"symbol":{"type":"string","description":"The ticker symbol for this organization. Example: ININ, AAPL, MSFT, etc."},"exchange":{"type":"string","description":"The exchange for this ticker symbol. Examples: NYSE, FTSE, NASDAQ, etc."}}},"GreetingMediaInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"mediaFileUri":{"type":"string","format":"uri"},"mediaImageUri":{"type":"string","format":"uri"}}},"AuditEntityReference":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"},"type":{"type":"string","enum":["ATTRIBUTE","ATTRIBUTE_GROUP_INSTANCE","DOCUMENT","DOWNLOAD","FAX","GROUP","RECORDING","TAG","WORKSPACE","USER","PUBLIC","FILE","INDEX","DATABASE","PROPERTY","TEXT","THUMBNAIL"]},"action":{"type":"string"}}},"Wrapup":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"notes":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"durationSeconds":{"type":"integer","format":"int32"},"endTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"provisional":{"type":"boolean","default":false}}},"Reaction":{"type":"object","properties":{"data":{"type":"string"},"name":{"type":"string"},"reactionType":{"type":"string","enum":["HANGUP","TRANSFER","TRANSFER_FLOW","PLAY_FILE"]}}},"ChatSearchListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ChatSearchItem"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ScriptEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Script"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ChannelEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Channel"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PhonesReboot":{"type":"object","properties":{"phoneIds":{"type":"array","items":{"type":"string"}},"siteId":{"type":"string"}}},"ManagementUnitTimezone":{"type":"object","properties":{"timezone":{"type":"string"}}},"Utilization":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"utilization":{"type":"object","description":"Map of media types to utilization settings.  Map keys can be: call, chat, email, or socialExpression","additionalProperties":{"$ref":"#/definitions/OrgMediaUtilization"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkItemSubmitRequest":{"type":"object","required":["commandId"],"properties":{"commandId":{"type":"string","description":"The command associated with the submit request. Often it is the button pressed on the user interface."},"dataItems":{"type":"array","description":"The data items that should be a part of the submit request.","items":{"$ref":"#/definitions/DataItem"}}},"description":"Used as the body to the submitWorkItem request."},"ScheduleGroupEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ScheduleGroup"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Ring":{"type":"object","properties":{"expansionCriteria":{"type":"array","items":{"$ref":"#/definitions/ExpansionCriterium"}},"actions":{"$ref":"#/definitions/Actions"}}},"PhoneNumber":{"type":"object","properties":{"display":{"type":"string"},"extension":{"type":"integer","format":"int64"},"acceptsSMS":{"type":"boolean","default":false},"userInput":{"type":"string"},"e164":{"type":"string"},"countryCode":{"type":"string"}}},"PaymentMethodListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/PaymentMethod"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PolicyEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Policy"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PaymentTokenProvider":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"tokenCreationRequestEnvelope":{"type":"object","additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WrapupCode":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrganizationRoleEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationRole"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainLogicalInterface":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"edgeUri":{"type":"string","format":"uri"},"edgeAssignedId":{"type":"string"},"friendlyName":{"type":"string"},"vlanTagId":{"type":"integer","format":"int32"},"hardwareAddress":{"type":"string"},"physicalAdapterId":{"type":"string"},"ipAddress":{"type":"string"},"gateway":{"type":"string"},"primaryDns":{"type":"string"},"secondaryDns":{"type":"string"},"ifStatus":{"type":"string"},"routes":{"type":"array","items":{"$ref":"#/definitions/DomainNetworkRoute"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/DomainNetworkAddress"}},"ipv4Capabilities":{"$ref":"#/definitions/DomainCapabilities"},"ipv6Capabilities":{"$ref":"#/definitions/DomainCapabilities"},"currentState":{"type":"string","enum":["INIT","CREATING","UPDATING","OK","EXCEPTION","DELETING"]},"lastModifiedUserId":{"type":"string"},"lastModifiedCorrelationId":{"type":"string"},"commandResponses":{"type":"array","items":{"$ref":"#/definitions/DomainNetworkCommandResponse"}},"inheritPhoneTrunkBases":{"type":"boolean","description":"Phone trunk base assignment will be inherited from the Edge Group.","default":false},"useForInternalEdgeCommunication":{"type":"boolean","description":"This interface will be used for all internal edge-to-edge communication using settings from the edgeTrunkBaseAssignment on the Edge Group.","default":false},"externalTrunkBaseAssignments":{"type":"array","description":"External trunk base settings to use for external communication from this interface.","items":{"$ref":"#/definitions/TrunkBaseAssignment"}},"phoneTrunkBaseAssignments":{"type":"array","description":"Phone trunk base settings to use for phone communication from this interface.  These settings will be ignored when \"inheritPhoneTrunkBases\" is true.","items":{"$ref":"#/definitions/TrunkBaseAssignment"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowState":{"type":"object","required":["stateConfigId","stateExecId"],"properties":{"stateExecId":{"type":"string","description":"The identifier of the execution instance of this State."},"stateConfigId":{"type":"string","description":"The identifier of the definition of this State."},"stateName":{"type":"string","description":"The displayable name of this State."}},"description":"Information about the a State of a flow"},"Geolocation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","description":"A string used to describe the type of client the geolocation is being updated from e.g. ios, android, web, etc."},"primary":{"type":"boolean","description":"A boolean used to tell whether or not to set this geolocation client as the primary on a PATCH","default":false},"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"},"country":{"type":"string"},"region":{"type":"string"},"city":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ServiceEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Service"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GroupImages":{"type":"object","properties":{"activeImages":{"type":"array","items":{"$ref":"#/definitions/UserImage"}}}},"SecurityProfile":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ChannelTopicEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ChannelTopic"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Page":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"versionId":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"rootContainer":{"type":"object","additionalProperties":{"type":"object"}},"properties":{"type":"object","additionalProperties":{"type":"object"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DownloadResponse":{"type":"object","properties":{"contentLocationUri":{"type":"string"},"imageUri":{"type":"string"}}},"TimeSlot":{"type":"object","properties":{"startTime":{"type":"string"},"stopTime":{"type":"string"},"day":{"type":"integer","format":"int32"}}},"ExtensionPoolEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ExtensionPool"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LineStatus":{"type":"object","properties":{"id":{"type":"string","description":"The id of this line"},"reachable":{"type":"boolean","description":"Indicates whether the edge can reach the line.","default":false},"addressOfRecord":{"type":"string","description":"The line's address of record."},"contactAddresses":{"type":"array","description":"The addresses used to contact the line.","items":{"type":"string"}},"reachableStateTime":{"type":"string","format":"date-time","description":"The time the line entered its current reachable state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"FacetKeyAttribute":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"VoicemailMailboxInfo":{"type":"object","properties":{"usageSizeBytes":{"type":"integer","format":"int64"},"totalCount":{"type":"integer","format":"int32"},"unreadCount":{"type":"integer","format":"int32"},"voicemailPolicy":{"$ref":"#/definitions/VoicemailUserPolicy"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"Permissions":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"ids":{"type":"array","items":{"type":"string"}}}},"Carrier":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"accountManager":{"$ref":"#/definitions/AccountManager"},"support":{"$ref":"#/definitions/Support"},"nocSupport":{"$ref":"#/definitions/NocSupport"},"services":{"type":"array","items":{"$ref":"#/definitions/Service"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"address":{"$ref":"#/definitions/CarrierAddress"}}},"TagModel":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"FlowConfigMetaDataEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/FlowConfigMetaData"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Occurrence":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["EVENT","SECONDS","MINUTES","INTERVALS"]}}},"CallRecord":{"type":"object","properties":{"lastAttempt":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"lastResult":{"type":"string"}}},"QueryFacetInfo":{"type":"object","properties":{"attributes":{"type":"array","items":{"$ref":"#/definitions/FacetKeyAttribute"}},"facets":{"type":"array","items":{"$ref":"#/definitions/FacetEntry"}}}},"FaxDocument":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"contentUri":{"type":"string","format":"uri"},"workspace":{"$ref":"#/definitions/UriReference"},"createdBy":{"$ref":"#/definitions/UriReference"},"contentType":{"type":"string"},"contentLength":{"type":"integer","format":"int64"},"filename":{"type":"string"},"read":{"type":"boolean","default":false},"pageCount":{"type":"integer","format":"int64"},"callerAddress":{"type":"string"},"receiverAddress":{"type":"string"},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}},"sharingUri":{"type":"string","format":"uri"},"downloadSharingUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LineEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Line"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PromptEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Prompt"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowVersion":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"commitVersion":{"type":"string"},"configurationVersion":{"type":"string"},"type":{"type":"string","enum":["PUBLISH","CHECKIN","SAVE"]},"createdBy":{"$ref":"#/definitions/UriReference"},"configurationUri":{"type":"string"},"dateCreated":{"type":"integer","format":"int64"},"generationId":{"type":"string"},"publishResultUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Evaluation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversation":{"$ref":"#/definitions/Conversation"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"evaluator":{"$ref":"#/definitions/User"},"agent":{"$ref":"#/definitions/User"},"calibration":{"$ref":"#/definitions/Calibration"},"status":{"type":"string","enum":["PENDING","INPROGRESS","FINISHED"]},"answers":{"$ref":"#/definitions/EvaluationScoringSet"},"agentHasRead":{"type":"boolean","default":false},"releaseDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"assignedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"changedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"queue":{"$ref":"#/definitions/Queue"},"resourceId":{"type":"string","description":"Only used for email evaluations. Will be null for all other evaluations."},"resourceType":{"type":"string","description":"The type of resource. Only used for email evaluations. Will be null for evaluations on all other resources.","enum":["Email"]},"redacted":{"type":"boolean","description":"Is only true when the user making the request does not have sufficient permissions to see evaluation","default":false},"isScoringIndex":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConsultTransferResponse":{"type":"object","required":["destinationParticipantId"],"properties":{"destinationParticipantId":{"type":"string","description":"Participant ID to whom the call is being transferred."}}},"DocumentAuditEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DocumentAudit"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PolicyErrorMessage":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32"},"userMessage":{"type":"object"},"userParamsMessage":{"type":"string"},"errorCode":{"type":"string"},"correlationId":{"type":"string"},"userParams":{"type":"array","items":{"$ref":"#/definitions/UserParam"}},"insertDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"LocationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Location"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GroupTag":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation date for the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date the entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"type":{"type":"string","description":"Defines which entity this Group Tag may be used for.  'ANY' for all entities.","enum":["GISTENER","SOCIALACCOUNT","ANY"]},"enabled":{"type":"boolean","description":"Indicates if this Group Tag is available for selection by other entities","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Campaign":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string"},"phoneNumberColumns":{"type":"array","items":{"$ref":"#/definitions/PhoneNumberColumn"}},"skipPreviewDisabled":{"type":"boolean","default":false},"previewTimeOutSeconds":{"type":"integer","format":"int32"}}},"CampaignEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Campaign"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ResponseText":{"type":"object","required":["content"],"properties":{"content":{"type":"string","description":"Response text content."},"contentType":{"type":"string","description":"Response text content type."}},"description":"Contains information about the text associated with a response."},"VoicemailMessage":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"conversation":{"$ref":"#/definitions/Conversation"},"read":{"type":"boolean","default":false},"audioRecordingDurationSeconds":{"type":"integer","format":"int32"},"audioRecordingSizeBytes":{"type":"integer","format":"int64"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"callerAddress":{"type":"string"},"callerName":{"type":"string"},"callerUser":{"$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhoneCapabilities":{"type":"object","properties":{"provisions":{"type":"boolean","default":false},"registers":{"type":"boolean","default":false},"dualRegisters":{"type":"boolean","default":false},"hardwareIdType":{"type":"string"},"allowReboot":{"type":"boolean","default":false},"noRebalance":{"type":"boolean","default":false}}},"AvailableAdditionalServiceListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/AvailableAdditionalService"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Certificate":{"type":"object","required":["certificate"],"properties":{"certificate":{"type":"string","description":"The certificate to parse."}},"description":"Represents a certificate to parse."},"VoiceRateInternational":{"type":"object","required":["amendmentId","currency","destination","durationIncrementSeconds","durationMinimumSeconds","effectiveDate","origin","rate","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"currency":{"type":"string","description":"The ISO 4217 currency code of the voice rate."},"amendmentId":{"type":"string","description":"The amendment Id of the voice rate."},"type":{"type":"string","description":"The voice rate type.","enum":["RATE_TOLL_FREE","RATE_TOLLED","OUTBOUND_INTERSTATE","OUTBOUND_INTRASTATE","OUTBOUND_LOCAL","EXTENDED"]},"effectiveDate":{"type":"string","format":"date-time","description":"The effective date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"rate":{"type":"number","description":"The rate."},"durationMinimumSeconds":{"type":"integer","format":"int32","description":"The minimum duration charged in seconds."},"durationIncrementSeconds":{"type":"integer","format":"int32","description":"The billing duration increment in seconds."},"origin":{"type":"string","description":"The origin."},"destination":{"type":"string","description":"The destination."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Action":{"type":"object","properties":{"type":{"type":"string"},"actionTypeName":{"type":"string"},"updateOption":{"type":"string"},"properties":{"type":"object","additionalProperties":{"type":"string"}}}},"ReplaceRequest":{"type":"object","properties":{"changeNumber":{"type":"integer","format":"int32"},"name":{"type":"string"},"authToken":{"type":"string"}}},"EdgeInterface":{"type":"object","properties":{"type":{"type":"string"},"ipAddress":{"type":"string"},"name":{"type":"string"},"macAddress":{"type":"string"},"ifName":{"type":"string"},"endpoints":{"type":"array","items":{"$ref":"#/definitions/UriReference"}},"lineTypes":{"type":"array","items":{"type":"string","enum":["TIE","NETWORK","TRUNK","STATION"]}},"addressFamilyId":{"type":"string"}}},"PredictionResults":{"type":"object","required":["estimatedWaitTimeSeconds","formula"],"properties":{"formula":{"type":"string","description":"Indicates the estimated wait time Formula","enum":["BEST","SIMPLE","ABANDON","PATIENCEABANDON"]},"estimatedWaitTimeSeconds":{"type":"integer","format":"int32","description":"Estimated wait time in seconds"}}},"WorkspaceSummary":{"type":"object","properties":{"totalDocumentCount":{"type":"integer","format":"int64"}}},"PenetrationRateId":{"type":"object","properties":{"contactList":{"$ref":"#/definitions/UriReference"},"qualifier":{"$ref":"#/definitions/UriReference"}}},"EncryptionKey":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"createDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"keydataSummary":{"type":"string"},"user":{"$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LicensesByPermission":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"licenses":{"type":"array","items":{"$ref":"#/definitions/License"}}}},"DomainLicenseEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DomainLicense"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Control":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/definitions/ControlOptions"}},"required":{"type":"boolean","default":false},"readOnly":{"type":"boolean","default":false},"variableBindingId":{"type":"string"},"type":{"type":"string","enum":["CHECKBOX","RADIO","SELECT"]}}},"WorkItemActions":{"type":"object","properties":{"canSubmit":{"type":"boolean","default":false}}},"EdgeLogsJobUploadRequest":{"type":"object","properties":{"fileIds":{"type":"array","items":{"type":"string"}}}},"ChatSearchItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"from":{"$ref":"#/definitions/ChatParticipant"},"to":{"$ref":"#/definitions/ChatParticipant"},"body":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConversationResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationFormAndScoringSet":{"type":"object","properties":{"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"answers":{"$ref":"#/definitions/EvaluationScoringSet"}}},"RelationshipListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Relationship"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ConnectRate":{"type":"object","properties":{"attempts":{"type":"integer","format":"int64"},"connects":{"type":"integer","format":"int64"},"connectRatio":{"type":"number","format":"double"}}},"AvailableTopicEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/AvailableTopic"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TagValueEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/TagValue"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TimeInterval":{"type":"object","properties":{"days":{"type":"integer","format":"int32"},"hours":{"type":"integer","format":"int32"}}},"OneLogin":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"certificate":{"type":"string"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Charge":{"type":"object","properties":{"licenseCount":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"price":{"type":"number"},"unitOfMeasure":{"type":"string"},"billingPeriod":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"includedUnits":{"type":"integer","format":"int32"}}},"DomainVoiceRateInternationalResponseItemEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/VoiceRateInternational"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SocialAccount":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation date for the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date the entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"enabled":{"type":"boolean","description":"Indicates if this Social Account is available for selection by other entities","default":false},"authorized":{"type":"boolean","description":"True when successfully completing the third-party authorization process","default":false},"socialHub":{"type":"string","description":"Which third party Social Media Hub this account will be communicating through"},"access_token":{"type":"string","description":"Credential provided through the Social Hub's authorization process"},"access_token_secret":{"type":"string","description":"Credential provided through the Social Hub's authorization process"},"twitterId":{"type":"string","description":"The account ID as provided by Twitter during the authorization process"},"streamingEnabled":{"type":"boolean","description":"Indicates if a stream should be opened on behalf of the indicated Social Hub account","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DependencyObject":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"string"},"type":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BRIDGEACTION","COMPOSERSCRIPT","CONTACTLIST","INBOUNDCALLFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","OUTBOUNDCALLFLOW","QUEUE","SYSTEMPROMPT","USER","USERPROMPT","VOICEXML"]},"deleted":{"type":"boolean","default":false},"consumedResources":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"consumingResources":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"View":{"type":"object","properties":{"url":{"type":"string"}}},"DomainThirdPartySubscriptionEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ThirdPartySubscription"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Extension":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"number":{"type":"string"},"owner":{"description":"A Uri reference to the owner of this extension, which is either a User or an IVR","$ref":"#/definitions/UriReference"},"extensionPool":{"$ref":"#/definitions/UriReference"},"ownerType":{"type":"string","enum":["USER","PHONE","IVR_CONFIG","GROUP"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Quote":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"purchaseOrder":{"type":"string"},"type":{"type":"string","enum":["NEW_SUBSCRIPTION","AMENDMENT"]},"status":{"type":"string","enum":["IN_PROGRESS","SUBMITTED","FROZEN"]},"isSubmitted":{"type":"boolean","default":false},"isPending":{"type":"boolean","default":false},"isFrozen":{"type":"boolean","default":false},"currency":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"lastUpdatedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"billingContactEmail":{"type":"string"},"billingContactFirstName":{"type":"string"},"billingContactLastName":{"type":"string"},"billingContactPhone":{"type":"string"},"includeVoiceCharges":{"type":"boolean","default":false},"charges":{"type":"array","items":{"$ref":"#/definitions/QuoteCharge"}},"edgeControlModel":{"type":"string"},"referralCodes":{"type":"array","items":{"type":"string"}},"discountCodes":{"type":"array","items":{"type":"string"}},"salesPartnerCode":{"type":"string"},"isAnnualPrepay":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeAllowed":{"type":"object","properties":{"timeSlots":{"type":"array","items":{"$ref":"#/definitions/TimeSlot"}},"timeZoneId":{"type":"string"},"empty":{"type":"boolean","default":false}}},"Skill":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Filter":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"operator":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}},"UserActionCategoryEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/UserActionCategory"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowHistoryResultItem":{"type":"object","required":["flowInstance"],"properties":{"flowInstance":{"description":"The flow instance information that applies to the history events.","$ref":"#/definitions/FlowDetails"},"availableActions":{"description":"The actions available for operating in the flow, with respect to your authorization identity.","$ref":"#/definitions/BackendFlowAvailableActions"},"historyItems":{"type":"array","description":"The ordered list of history events for this flow.","items":{"$ref":"#/definitions/FlowHistoryItem"}}},"description":"Information about one flow history item"},"PhoneNumberColumn":{"type":"object","properties":{"columnName":{"type":"string"},"type":{"type":"string"}}},"Alert":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"unread":{"type":"boolean","default":false},"entity":{"$ref":"#/definitions/Entity"},"metric":{"type":"string"},"metricThresholds":{"type":"array","items":{"$ref":"#/definitions/MetricThreshold"}},"metricValue":{"type":"number","format":"double"},"startTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"endTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"mediaType":{"type":"string","enum":["VOICE","CHAT"]},"statistic":{"type":"string","enum":["COUNT","SUM","AVG","RATIO"]},"ruleUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QuestionGroup":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"defaultAnswersToHighest":{"type":"boolean","default":false},"defaultAnswersToNA":{"type":"boolean","default":false},"naEnabled":{"type":"boolean","default":false},"weight":{"type":"number","format":"float"},"manualWeight":{"type":"boolean","default":false},"questions":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}}}},"BasicTransform":{"type":"object","properties":{"replaces":{"type":"array","items":{"$ref":"#/definitions/TransformLens"}},"entityPath":{"type":"array","items":{"type":"string"}}}},"DncListEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DncList"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Location":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"address":{"type":"string"},"addressFields":{"$ref":"#/definitions/LocationAddressFields"},"addressVerified":{"type":"boolean","default":false},"emergencyNumber":{"$ref":"#/definitions/LocationEmergencyNumber"},"notes":{"type":"string"},"path":{"type":"array","items":{"type":"string"}},"state":{"type":"string","description":"Current activity status of the location.","enum":["active","inactive"]},"sublocationOrder":{"type":"array","items":{"type":"string"}},"version":{"type":"number","format":"double"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Account":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"orgLegalName":{"type":"string"},"billingAddressLine1":{"type":"string"},"billingAddressLine2":{"type":"string"},"billingAddressCity":{"type":"string"},"billingAddressState":{"type":"string"},"billingAddressZipCode":{"type":"string"},"billingAddressCountry":{"type":"string"},"legalAddressLine1":{"type":"string"},"legalAddressLine2":{"type":"string"},"legalAddressCity":{"type":"string"},"legalAddressState":{"type":"string"},"legalAddressZipCode":{"type":"string"},"legalAddressCountry":{"type":"string"},"billingContactFirstName":{"type":"string"},"billingContactLastName":{"type":"string"},"billingContactEmail":{"type":"string"},"billingContactPhone":{"type":"string"},"purchaseOrderNumber":{"type":"string"},"isTaxExempt":{"type":"boolean","default":false},"currency":{"type":"string"},"paymentTerm":{"type":"string"},"contractTerm":{"type":"integer","format":"int32"},"autoRenew":{"type":"boolean","default":false},"enabled":{"type":"boolean","default":false},"minCommitQuantities":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"estimatedQuantities":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"oneTimeCharges":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Invoice":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"invoiceNumber":{"type":"string"},"invoiceDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dueDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"amount":{"type":"string"},"balance":{"type":"string"},"status":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkItemDefinition":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The configuration ID for this workItem"},"name":{"type":"string"},"commandCategories":{"type":"array","description":"The commands that can be performed on this work item","items":{"$ref":"#/definitions/WorkItemCommandGroup"}},"form":{"description":"The simple work item form containging the control to present for this work item","$ref":"#/definitions/Form"}}},"DomainPermissionPolicy":{"type":"object","properties":{"domain":{"type":"string"},"entityName":{"type":"string"},"policyName":{"type":"string"},"policyDescription":{"type":"string"},"actionSet":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"namedResources":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"allowConditions":{"type":"boolean","default":false},"resourceConditionNode":{"$ref":"#/definitions/DomainResourceConditionNode"}}},"Support":{"type":"object","properties":{"phone":{"type":"string"},"email":{"type":"string"},"website":{"type":"string"}}},"KeyRotationSchedule":{"type":"object","required":["period"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"period":{"type":"string","description":"Value to set schedule to","enum":["DISABLED","DAILY","WEEKLY","MONTHLY","YEARLY"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkspaceCreate":{"type":"object","properties":{"name":{"type":"string"},"bucket":{"type":"string"}}},"QualityAuditPage":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/QualityAudit"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ResponseQueryResults":{"type":"object","required":["results"],"properties":{"results":{"description":"Contains the query results","$ref":"#/definitions/ResponseEntityList"}},"description":"Used to return response query results"},"SchemaReferenceEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DomainSchemaReference"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SocializeEntityFilter":{"type":"object","properties":{"fieldName":{"type":"string","description":"The fieldName the filter will be applied to."},"operator":{"type":"string","description":"The operator to apply when filtering.","enum":["EQ","NEG_EQ","CONTAINS","NEG_CONTAINS","STARTS_WITH","NEG_STARTS_WITH","ENDS_WITH","NEG_ENDS_WITH","BT","GT","LT","GE","LE","IN"]},"fieldValue":{"type":"string","description":"The value to filter on."}}},"OrganizationPresenceEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OrganizationPresence"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SortItem":{"type":"object","properties":{"name":{"type":"string"},"ascending":{"type":"boolean","default":false}}},"DependencyStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"buildId":{"type":"string"},"dateStarted":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateCompleted":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"status":{"type":"string","enum":["BUILDINITIALIZING","BUILDINPROGRESS","NOTBUILT","OPERATIONAL","OPERATIONALNEEDSREBUILD"]},"failedObjects":{"type":"array","items":{"$ref":"#/definitions/FailedObject"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ShareEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Share"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"QueueMemberEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ServiceType":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"codecs":{"type":"array","items":{"type":"string"}},"strip":{"type":"string","description":"Prefix striping is a mechanism to remove digits from the beginning of a phone number before sending a call out to a carrier, such as international exit codes. This must be configurable on a per carrier basis as all carriers act differently."},"callingPartyId":{"type":"string"},"callHistory":{"type":"string"},"prefix":{"type":"string"}}},"EdgeAutoUpdateConfig":{"type":"object","properties":{"timeZone":{"type":"string"},"rrule":{"type":"string"},"start":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"end":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"CommonAuditRequest":{"type":"object","properties":{"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"sortBy":{"type":"array","items":{"$ref":"#/definitions/SortBy"}},"queryPhrase":{"type":"string"},"queryFields":{"type":"array","items":{"type":"string"}},"facets":{"type":"array","items":{"$ref":"#/definitions/Facet"}},"filters":{"type":"array","items":{"$ref":"#/definitions/Filter"}}}},"DomainCertificateAuthority":{"type":"object","required":["certificate","services","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"certificate":{"type":"string","description":"The authorities signed X509 PEM encoded certificate."},"type":{"type":"string","description":"The certificate authorities type.  Managed certificate authorities are generated and maintained by Interactive Intelligence.  These are read-only and not modifiable by clients.  Remote authorities are customer managed.","enum":["MANAGED","REMOTE"]},"services":{"type":"array","description":"The service(s) that the authority can be used to authenticate.","items":{"type":"string","enum":["SIP","PROVISION","PROVISION_PHONE"]}},"certificateDetails":{"type":"array","description":"The details of the parsed certificate(s).","items":{"$ref":"#/definitions/CertificateDetails"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A certificate authority represents an organization that has issued a digital certificate for making secure connections with an edge device."},"DocumentAudit":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/UriReference"},"workspace":{"$ref":"#/definitions/UriReference"},"transactionId":{"type":"string"},"transactionInitiator":{"type":"boolean","default":false},"application":{"type":"string"},"serviceName":{"type":"string"},"level":{"type":"string","enum":["USER","SYSTEM"]},"timestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"status":{"type":"string","enum":["SUCCESS","FAILURE"]},"actionContext":{"type":"string","enum":["CREATE","READ","UPDATE","DELETE","DOWNLOAD","VIEW","UPLOAD","SAVE","MOVE","COPY","ADD","REMOVE","RECEIVE","CONVERT","FAX","CREATE_COVERPAGE","USER_ADD","USER_REMOVE","MEMBER_ADD","MEMBER_REMOVE","MEMBER_UPDATE","TAG_ADD","TAG_REMOVE","TAG_UPDATE","ATTRIBUTE_ADD","ATTRIBUTE_REMOVE","ATTRIBUTE_UPDATE","ATTRIBUTE_GROUP_INSTANCE_ADD","ATTRIBUTE_GROUP_INSTANCE_REMOVE","ATTRIBUTE_GROUP_INSTANCE_UPDATE","INDEX_SAVE","INDEX_DELETE","INDEX_CREATE","FILE_SAVE","FILE_DELETE","FILE_READ","THUMBNAIL_CREATE","TEXT_EXTRACT","SHARE_ADD","SHARE_REMOVE","VERSION_CREATE"]},"action":{"type":"string","enum":["CREATE","READ","UPDATE","DELETE","DOWNLOAD","VIEW","UPLOAD","SAVE","MOVE","COPY","ADD","REMOVE","RECEIVE","CONVERT","FAX","CREATE_COVERPAGE","USER_ADD","USER_REMOVE","MEMBER_ADD","MEMBER_REMOVE","MEMBER_UPDATE","TAG_ADD","TAG_REMOVE","TAG_UPDATE","ATTRIBUTE_ADD","ATTRIBUTE_REMOVE","ATTRIBUTE_UPDATE","ATTRIBUTE_GROUP_INSTANCE_ADD","ATTRIBUTE_GROUP_INSTANCE_REMOVE","ATTRIBUTE_GROUP_INSTANCE_UPDATE","INDEX_SAVE","INDEX_DELETE","INDEX_CREATE","FILE_SAVE","FILE_DELETE","FILE_READ","THUMBNAIL_CREATE","TEXT_EXTRACT","SHARE_ADD","SHARE_REMOVE","VERSION_CREATE"]},"entity":{"$ref":"#/definitions/AuditEntityReference"},"changes":{"type":"array","items":{"$ref":"#/definitions/AuditChange"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IVREntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/IVR"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DialerAuditRequest":{"type":"object","properties":{"queryPhrase":{"type":"string"},"queryFields":{"type":"array","items":{"type":"string"}},"facets":{"type":"array","items":{"$ref":"#/definitions/Facet"}},"filters":{"type":"array","items":{"$ref":"#/definitions/Filter"}}}},"IntegrationType":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"provider":{"type":"string","enum":["BRIDGE","WEBHOOKS","REALTIME"]},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SystemPrompt":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"resources":{"type":"array","items":{"$ref":"#/definitions/SystemPromptAsset"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowConfigMetaData":{"type":"object","required":["flowType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"configState":{"type":"string","description":"Usability of this flow definition. (output only)","enum":["UNKNOWN","ACTIVE","INACTIVE","DELETED"]},"flowType":{"type":"string","description":"Type of flow this definition describes","enum":["UNKNOWN","WORKFLOW"]},"lockedByUser":{"description":"If locked for editing, the user who locked this definition, otherwise null","$ref":"#/definitions/User"},"newestPublishedVersion":{"type":"string","description":"The most recently published version (output only)"},"newestVersion":{"type":"string","description":"The most recent version, regardless of published state (output only)"},"associatedWorkspaces":{"type":"array","description":"Workspaces associated with this flow.","items":{"$ref":"#/definitions/Workspace"}},"description":{"type":"string","description":"User notes describing the flow definition."},"hasDraft":{"type":"boolean","description":"Flag if this definition has a draft populated.","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details about the current state of a Flow Definition"},"EndpointEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Endpoint"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PublishScriptRequestData":{"type":"object","properties":{"scriptId":{"type":"string"},"versionId":{"type":"string"}}},"Bullseye":{"type":"object","properties":{"rings":{"type":"array","items":{"$ref":"#/definitions/Ring"}}}},"CreateCallbackCommand":{"type":"object","properties":{"scriptId":{"type":"string"},"queueId":{"type":"string"},"callbackUserName":{"type":"string"},"callbackNumbers":{"type":"array","items":{"type":"string"}},"countryCode":{"type":"string"},"skipEnabled":{"type":"boolean","default":false}}},"PhoneBase":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"phoneMetaBase":{"$ref":"#/definitions/UriReference"},"lines":{"type":"array","items":{"$ref":"#/definitions/LineBase"}},"properties":{"type":"object","additionalProperties":{"type":"object"}},"capabilities":{"$ref":"#/definitions/PhoneCapabilities"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TransformLens":{"type":"object","properties":{"replace":{"type":"string"},"value":{"type":"string"}}},"PhoneNumberStatus":{"type":"object","properties":{"callable":{"type":"boolean","default":false}}},"DocumentThumbnail":{"type":"object","properties":{"resolution":{"type":"string"},"imageUri":{"type":"string"}}},"Station":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["AVAILABLE","ASSOCIATED"]},"userId":{"type":"string"},"primaryEdge":{"$ref":"#/definitions/UriReference"},"secondaryEdge":{"$ref":"#/definitions/UriReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrphanRecordingListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OrphanRecording"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AttributeQueryRequest":{"type":"object","properties":{"query":{"type":"string","description":"Query phrase to search attribute by name. If not set will match all."},"pageSize":{"type":"integer","format":"int32","description":"The maximum number of hits to return. Default: 25, Maximum: 500."},"pageNumber":{"type":"integer","format":"int32","description":"The page number to start at. The first page is number 1."}},"description":"Used to query for attributes"},"DependencyObjectEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DependencyObject"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CommandStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"expiration":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"userId":{"type":"string"},"statusCode":{"type":"string","enum":["INPROGRESS","COMPLETE","ERROR","CANCELING","CANCELED"]},"commandType":{"type":"string","enum":["UPLOAD","COPYDOCUMENT","MOVEDOCUMENT","DELETEWORKSPACE","DELETEDOCUMENT","DELETETAG","UPDATETAG","REINDEX","CLEANUP","REPLACEDOCUMENT"]},"document":{"$ref":"#/definitions/Document"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OutboundRouteEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OutboundRoute"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Rule":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"enabled":{"type":"boolean","default":false},"metric":{"type":"string"},"entity":{"$ref":"#/definitions/Entity"},"metricThresholds":{"type":"array","items":{"$ref":"#/definitions/MetricThreshold"}},"inAlarm":{"type":"boolean","default":false},"occurrence":{"$ref":"#/definitions/Occurrence"},"mediaType":{"type":"string","enum":["VOICE","CHAT"]},"statistic":{"type":"string","enum":["COUNT","SUM","AVG","RATIO"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallForwarding":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"enabled":{"type":"boolean","default":false},"phoneNumber":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Contract":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"quote":{"$ref":"#/definitions/Quote"},"signerUrl":{"type":"string"},"job":{"$ref":"#/definitions/ContractJob"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Site":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"state":{"type":"string","enum":["ACTIVE","DELETED","INACTIVE"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"primarySites":{"type":"array","items":{"$ref":"#/definitions/UriReference"}},"secondarySites":{"type":"array","items":{"$ref":"#/definitions/UriReference"}},"primaryEdges":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"secondaryEdges":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/OrganizationAddress"}},"edges":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"edgeAutoUpdateConfig":{"description":"Recurrance rule, time zone, and start/end settings for automatic edge updates for this site","$ref":"#/definitions/EdgeAutoUpdateConfig"},"location":{"$ref":"#/definitions/UriReference"},"managed":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SiteEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Site"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainBillingPeriodEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/BillingPeriod"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DncList":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"version":{"type":"integer","format":"int32"},"phoneNumberColumns":{"type":"array","items":{"type":"string"}},"importStatus":{"$ref":"#/definitions/ImportStatus"},"fileKey":{"type":"string"},"size":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EstimatedWaitTimePredictions":{"type":"object","required":["results"],"properties":{"results":{"type":"array","description":"Returned upon a successful estimated wait time request.","items":{"$ref":"#/definitions/PredictionResults"}}}},"CreateTemplateFromScriptRequestData":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"scriptId":{"type":"string"},"userId":{"type":"string"}}},"ChatParticipant":{"type":"object","properties":{"type":{"type":"string","enum":["USER","ROOM"]}}},"DataValueInfo":{"type":"object","properties":{"dataItems":{"type":"array","items":{"$ref":"#/definitions/DataItem"}}}},"QueryResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"body":{"$ref":"#/definitions/DomainEntity"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ParticipantRequest":{"type":"object","properties":{"id":{"type":"string"},"wrapup":{"$ref":"#/definitions/Wrapup"},"state":{"type":"string","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","NONE"]},"recording":{"type":"boolean","default":false},"muted":{"type":"boolean","default":false},"confined":{"type":"boolean","default":false},"held":{"type":"boolean","default":false},"wrapupSkipped":{"type":"boolean","default":false}}},"LogicalInterfaceEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DomainLogicalInterface"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportMetaDataEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ReportMetaData"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowLaunchRequest":{"type":"object","required":["flowConfigId","launchType"],"properties":{"flowConfigId":{"description":"ID of the flow to launch, will launch the most recently published version if a specific version is not specified.","$ref":"#/definitions/FlowConfigId"},"flowInstanceName":{"type":"string","description":"The displayable instance name to assign to the new flow instance (or omit to have one automatically generated)"},"inputData":{"description":"contains launch parameters or initializations for variables in the flow.","$ref":"#/definitions/FlowInputData"},"launchType":{"type":"string","description":"launch type of the flow - NORMAL or TEST","enum":["UNKNOWN","NORMAL","TEST","AUTOMATIC"]}},"description":"Passed into a flow to describe an object to launch and returned from the operation with the Id populated with the flowInstance launched."},"LocationAddressFields":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"countryName":{"type":"string"},"state":{"type":"string"},"street1":{"type":"string"},"street2":{"type":"string"},"zipcode":{"type":"string"}}},"Chat":{"type":"object","properties":{"jabberId":{"type":"string"}}},"EvaluationQueryRequest":{"type":"object","properties":{"conversationId":{"type":"string"},"userType":{"type":"string","enum":["EVALUATOR","AGENT"]},"currentUserId":{"type":"string"},"agentId":{"type":"string"},"queueId":{"type":"string"},"interval":{"type":"string"},"evaluationState":{"type":"array","items":{"type":"string","enum":["PENDING","INPROGRESS","FINISHED"]}},"isReleased":{"type":"boolean","default":false},"agentHasRead":{"type":"boolean","default":false},"expandAnswerTotalScores":{"type":"boolean","default":false},"maximum":{"type":"integer","format":"int32"}}},"SkillEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Skill"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"NumberOrderRequest":{"type":"object","properties":{"orderTns":{"type":"array","items":{"type":"string"}},"reservationIds":{"type":"array","items":{"type":"string"}},"orderId":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"phoneNumberType":{"type":"string","description":"The type of phone number (eg us-domestic, toll-free, etc), to determine which third-party api(s) to use for the order request.","enum":["TOLL_FREE","CN_DOMESTIC","US_DOMESTIC"]}}},"BatchCommand":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/BatchItem"}},"commandId":{"type":"string"}}},"FlowExecId":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"ID of a running flow instance."},"CreateShareRequestMember":{"type":"object","properties":{"memberType":{"type":"string","enum":["USER","PUBLIC"]},"member":{"$ref":"#/definitions/Entity"}}},"ResourceConditionValue":{"type":"object","properties":{"type":{"type":"string","enum":["SCALAR","VARIABLE","USER","QUEUE"]},"value":{"type":"string"}}},"ExternalContact":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"},"salutation":{"type":"string"},"title":{"type":"string"},"workPhone":{"$ref":"#/definitions/PhoneNumber"},"cellPhone":{"$ref":"#/definitions/PhoneNumber"},"homePhone":{"$ref":"#/definitions/PhoneNumber"},"otherPhone":{"$ref":"#/definitions/PhoneNumber"},"workEmail":{"type":"string"},"personalEmail":{"type":"string"},"otherEmail":{"type":"string"},"address":{"$ref":"#/definitions/Address"},"modifyDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"createDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"externalOrganization":{"$ref":"#/definitions/ExternalOrganization"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TransformEndpoint":{"type":"object","required":["ready"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"swaggerUrl":{"type":"string","description":"The Url to the swagger documentation of the endpoint where parsed entities will be posted"},"route":{"type":"string","description":"The swagger route to use"},"entity":{"type":"string","description":"The entity type being posted"},"apiFunction":{"type":"string","description":"The swagger function being called"},"ready":{"type":"boolean","description":"Whether this TransformEndpoint has been configured to work (security groups, permissions, etc)","default":false},"active":{"type":"boolean","description":"Whether this TransformEndpoint is currently active and accepting transformation operations","default":false},"batchSize":{"type":"integer","format":"int32","description":"The number of entities to send in an array for batch POSTs, or 0 for unbatched POSTs"},"parallelism":{"type":"integer","format":"int32","description":"The number of parallel POSTs to allow at once"},"updateProgressEvery":{"type":"integer","format":"int32","description":"The swagger route to use"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowDetailsSearchResult":{"type":"object","properties":{"searchResults":{"description":"The actual results from the search","$ref":"#/definitions/LinkedEntityListingFlowDetails"},"facetResults":{"type":"array","description":"The results from the facet requests for this search - note ALL facets will always be returned regardless of page size/starting pagenumber in the searchRequest","items":{"$ref":"#/definitions/FacetResult"}}},"description":"Contains the found elements of a search along with the facet result.  All facet results are always returned along with the searchResults regardless of page size/number."},"RetentionDuration":{"type":"object","properties":{"archiveRetention":{"$ref":"#/definitions/ArchiveRetention"},"deleteRetention":{"$ref":"#/definitions/DeleteRetention"}}},"TransformProgress":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"service":{"type":"string","description":"Name of this service"},"user":{"description":"User unique identifier","$ref":"#/definitions/User"},"uploadTime":{"type":"string","format":"date-time","description":"Time when file was uploaded. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"filename":{"type":"string","description":"Name of the file being parsed"},"tags":{"type":"array","description":"Tag matching for searching transformation schemas in use","items":{"$ref":"#/definitions/TagModel"}},"progress":{"description":"State of parsing progress for this upload transformation","$ref":"#/definitions/ProgressModel"},"model":{"description":"ID of the ratesheet","$ref":"#/definitions/TransformModel"},"errors":{"type":"array","description":"Errors encountered during parsing","items":{"$ref":"#/definitions/ErrorBody"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ColumnCollapse":{"type":"object","properties":{"label":{"type":"string"},"columns":{"type":"array","items":{"type":"integer","format":"int32"}}}},"QueryResults":{"type":"object","properties":{"results":{"$ref":"#/definitions/DomainEntityListingQueryResult"},"facetInfo":{"$ref":"#/definitions/QueryFacetInfo"}}},"PhoneColumn":{"type":"object","properties":{"columnName":{"type":"string"},"type":{"type":"string"}}},"Metabase":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LinkedEntityListingFlowDetails":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/FlowDetails"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeVersionInformation":{"type":"object","properties":{"softwareVersion":{"type":"string"}}},"Prompt":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"resources":{"type":"array","items":{"$ref":"#/definitions/PromptAsset"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"StationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Station"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Tag":{"type":"object","properties":{"label":{"type":"string"},"interactionFlag":{"type":"boolean","default":false}}},"Recording":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversationId":{"type":"string"},"path":{"type":"string"},"startTime":{"type":"string"},"endTime":{"type":"string"},"media":{"type":"string"},"mediaUri":{"type":"string"},"waveUri":{"type":"string"},"annotations":{"type":"array","items":{"$ref":"#/definitions/Annotation"}},"transcript":{"type":"array","items":{"$ref":"#/definitions/ChatMessage"}},"emailTranscript":{"type":"array","items":{"$ref":"#/definitions/EmailMessage"}},"fileState":{"type":"string","enum":["ARCHIVED","AVAILABLE","DELETED","RESTORED","RESTORING","UPLOADING"]},"restoreExpirationTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"mediaUris":{"type":"object","additionalProperties":{"$ref":"#/definitions/MediaResult"}},"estimatedTranscodeTimeMs":{"type":"integer","format":"int64"},"actualTranscodeTimeMs":{"type":"integer","format":"int64"},"archiveDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"archiveMedium":{"type":"string","enum":["CLOUDARCHIVE"]},"deleteDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"maxAllowedRestorationsForOrg":{"type":"integer","format":"int32"},"remainingRestorationsAllowedForOrg":{"type":"integer","format":"int32"},"recordingId":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowReportResultItem":{"type":"object","required":["currentState","flowConfigId","flowExecId","startDateTime"],"properties":{"flowExecId":{"description":"The flow instance ID for this process","$ref":"#/definitions/FlowExecId"},"flowConfigId":{"description":"The flow config ID that this workitem was created from.","$ref":"#/definitions/FlowConfigId"},"flowInstanceName":{"type":"string","description":"The instance name for this flow in relation to its primary document.  If the flow is not a document-centric type, this value will be empty."},"associatedDocument":{"description":"the document for this flow (if this flow was launched via a document)","$ref":"#/definitions/AssociatedDocument"},"flowStatus":{"type":"string","description":"The flow's running status, which indicates whether the flow is running normally or in error, etc;","enum":["UNKNOWN","RUNNING","ERROR","TERMINATED","COMPLETED"]},"currentState":{"type":"string","description":"The current state of the flow (EG what action is being processed)"},"startDateTime":{"type":"string","format":"date-time","description":"The time the flow was started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"endDateTime":{"type":"string","format":"date-time","description":"The time the flow ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"workItemUserAssignees":{"type":"array","description":"List of users currently assigned to a workItem","items":{"$ref":"#/definitions/User"}},"completedUser":{"description":"User that completed the flow","$ref":"#/definitions/User"},"completionReason":{"type":"string","description":"Reason for completion"},"flowErrorInfo":{"description":"Additional information if the flow is in error","$ref":"#/definitions/ErrorBody"}},"description":"Report for one active (running) process found in result to a report request."},"Share":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"sharedEntityType":{"type":"string","enum":["DOCUMENT"]},"sharedEntity":{"$ref":"#/definitions/UriReference"},"memberType":{"type":"string","enum":["USER","PUBLIC"]},"member":{"$ref":"#/definitions/UriReference"},"sharedBy":{"$ref":"#/definitions/UriReference"},"workspace":{"$ref":"#/definitions/UriReference"},"user":{"$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MediaSummary":{"type":"object","properties":{"contactCenter":{"type":"integer","format":"int32"},"enterprise":{"type":"integer","format":"int32"}}},"Policy":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"order":{"type":"integer","format":"int32"},"description":{"type":"string"},"enabled":{"type":"boolean","default":false},"mediaPolicies":{"description":"Conditions and actions per media type","$ref":"#/definitions/MediaPolicies"},"conditions":{"description":"Conditions","$ref":"#/definitions/PolicyConditions"},"actions":{"description":"Actions","$ref":"#/definitions/PolicyActions"},"policyErrors":{"$ref":"#/definitions/PolicyErrors"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"directions":{"type":"array","items":{"type":"string","enum":["INBOUND","OUTBOUND"]}},"dateRanges":{"type":"array","items":{"type":"string"}},"mediaTypes":{"type":"array","items":{"type":"string","enum":["CALL","CHAT"]}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"duration":{"$ref":"#/definitions/DurationCondition"},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"}}},"FacetStatistics":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"min":{"type":"number","format":"double"},"max":{"type":"number","format":"double"},"mean":{"type":"number","format":"double"},"stdDeviation":{"type":"number","format":"double"},"dateMin":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"dateMax":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"SecurityProfileEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/SecurityProfile"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DataItem":{"type":"object","properties":{"dataItemId":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"}}},"ExternalOrganization":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"companyType":{"type":"string"},"industry":{"type":"string"},"primaryContactId":{"type":"string"},"address":{"$ref":"#/definitions/Address"},"phoneNumber":{"$ref":"#/definitions/PhoneNumber"},"faxNumber":{"$ref":"#/definitions/PhoneNumber"},"employeeCount":{"type":"integer","format":"int64"},"revenue":{"type":"integer","format":"int64"},"tags":{"type":"array","items":{"type":"string"}},"websites":{"type":"array","items":{"type":"string"}},"tickers":{"type":"array","items":{"$ref":"#/definitions/Ticker"}},"modifyDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"createDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FavoriteTemplateRequestData":{"type":"object","properties":{"templateId":{"type":"string"}}},"VoiceRateInternationalEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/VoiceRateExtended"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AccountStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"orgName":{"type":"string"},"configured":{"type":"boolean","default":false},"adminUIURL":{"type":"string"},"thirdPartyAccountId":{"type":"string"},"thirdPartySubscriptionId":{"type":"string"},"thirdPartySubscriptionNonAcbId":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrganizationProductEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationProduct"}},"pageCount":{"type":"integer","format":"int32"}}},"DeltaRequest":{"type":"object","properties":{"contextToken":{"type":"string"}}},"DomainThirdPartyAccountEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ThirdPartyAccount"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"InboundDomainEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/InboundDomain"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FailedObject":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"name":{"type":"string"},"errorCode":{"type":"string"}}},"VoicemailMessageEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/VoicemailMessage"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"InboundRoute":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"pattern":{"type":"string","description":"The search pattern that the mailbox name should match."},"queue":{"description":"The queue to route the emails to.","$ref":"#/definitions/UriReference"},"priority":{"type":"integer","format":"int32","description":"The priority to use for routing."},"skills":{"type":"array","description":"The skills to use for routing.","items":{"$ref":"#/definitions/UriReference"}},"language":{"description":"The language to use for routing.","$ref":"#/definitions/UriReference"},"fromName":{"type":"string","description":"The sender name to use for outgoing replies."},"fromEmail":{"type":"string","description":"The sender email to use for outgoing replies."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConversationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Conversation"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DocumentAttribute":{"type":"object","properties":{"attribute":{"$ref":"#/definitions/Attribute"},"values":{"type":"array","items":{"type":"string"}}}},"Order":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"quote":{"$ref":"#/definitions/Quote"},"envelopeId":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Script":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"versionId":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"publishedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"versionDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"startPageId":{"type":"string"},"startPageName":{"type":"string"},"features":{"type":"object"},"variables":{"type":"object"},"customActions":{"type":"object"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VoiceRate":{"type":"object","required":["amendmentId","currency","durationIncrementSeconds","durationMinimumSeconds","effectiveDate","rate","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"currency":{"type":"string","description":"The ISO 4217 currency code of the voice rate."},"amendmentId":{"type":"string","description":"The amendment Id of the voice rate."},"type":{"type":"string","description":"The voice rate type.","enum":["RATE_TOLL_FREE","RATE_TOLLED","OUTBOUND_INTERSTATE","OUTBOUND_INTRASTATE","OUTBOUND_LOCAL","EXTENDED"]},"effectiveDate":{"type":"string","format":"date-time","description":"The effective date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"rate":{"type":"number","description":"The rate."},"durationMinimumSeconds":{"type":"integer","format":"int32","description":"The minimum duration charged in seconds."},"durationIncrementSeconds":{"type":"integer","format":"int32","description":"The billing duration increment in seconds."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmailMessage":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"to":{"type":"array","description":"The recipients of the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"cc":{"type":"array","description":"The recipients that were copied on the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"bcc":{"type":"array","description":"The recipients that were blind copied on the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"from":{"description":"The sender of the email message.","$ref":"#/definitions/EmailAddress"},"subject":{"type":"string","description":"The subject of the email message."},"attachments":{"type":"array","description":"The attachments of the email message.","items":{"$ref":"#/definitions/Attachment"}},"textBody":{"type":"string","description":"The text body of the email message."},"htmlBody":{"type":"string","description":"The html body of the email message."},"time":{"type":"string","format":"date-time","description":"The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UrlResponse":{"type":"object","properties":{"url":{"type":"string"}}},"Channel":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"connectUri":{"type":"string","format":"uri"}}},"QuestionScore":{"type":"object","properties":{"questionId":{"type":"string"},"answerId":{"type":"string"},"score":{"type":"integer","format":"int32"},"markedNA":{"type":"boolean","default":false},"failedKillQuestion":{"type":"boolean","default":false},"comments":{"type":"string"}}},"DocumentUpload":{"type":"object","properties":{"name":{"type":"string"},"workspace":{"$ref":"#/definitions/UriReference"},"tags":{"type":"array","items":{"type":"string"}},"tagIds":{"type":"array","items":{"type":"string"}}}},"EdgeLogsJob":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"files":{"type":"array","description":"The files available to upload from the Edge to the cloud.","items":{"$ref":"#/definitions/EdgeLogsJobFile"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SystemPromptEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/SystemPrompt"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ConsumedResourcesEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LineBase":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"lineMetaBase":{"$ref":"#/definitions/UriReference"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AvailableAdditionalService":{"type":"object","required":["availableForProducts","defaultForProducts","description","exclusiveFromProducts","partNumber","rate","requiredForProducts"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"The description of this additional service."},"partNumber":{"type":"string","description":"The part number of this additional service."},"requiredForProducts":{"type":"array","description":"The list of products which require this additional service.","items":{"type":"string"}},"availableForProducts":{"type":"array","description":"The list of products for which this additional service is available.","items":{"type":"string"}},"defaultForProducts":{"type":"array","description":"The list of products which have this additional service by default.","items":{"type":"string"}},"exclusiveFromProducts":{"type":"array","description":"The list of additional services which are not compatible with this additional service.","items":{"type":"string"}},"rate":{"description":"The rate of this additional service.","$ref":"#/definitions/Rate"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainCapabilities":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"dhcp":{"type":"boolean","default":false},"metric":{"type":"integer","format":"int32"}}},"CallableTime":{"type":"object","properties":{"timeSlots":{"type":"array","items":{"$ref":"#/definitions/TimeSlot"}},"timeZoneId":{"type":"string"}}},"ImportStatus":{"type":"object","properties":{"state":{"type":"string","enum":["IN_PROGRESS","FAILED"]},"totalRecords":{"type":"integer","format":"int64"},"completedRecords":{"type":"integer","format":"int64"},"percentComplete":{"type":"integer","format":"int32"},"failureReason":{"type":"string"}}},"QueueEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PaymentMethod":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","enum":["CARD_TOKEN"]},"providerName":{"type":"string"},"token":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AddressListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Address"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FacetItem":{"type":"object","properties":{"name":{"type":"string"},"filterValue":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"UploadProgress":{"type":"object","properties":{"CarrierId":{"type":"string","description":"Carrier id associated with the ratesheet that was uploaded.","readOnly":true},"SchemaName":{"type":"string","description":"Human readable name for the schema that was used to parse the ratesheet.","readOnly":true},"Status":{"type":"string","description":"Human readable status for progress of the ratesheet upload. This may be an error, the number of rates upload, or a completion message.","readOnly":true},"Filename":{"type":"string","description":"Filename of the ratesheet that was uploaded by the user.","readOnly":true},"Filetype":{"type":"string","description":"Media type of the file.","readOnly":true},"Created":{"type":"string","format":"date-time","description":"Time at which the uploaded ratesheet was started to be parsed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"Updated":{"type":"string","format":"date-time","description":"Time at which the progress of the upload was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true}}},"LinkedEntityListingWorkItemSearchDetails":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/WorkItemSearchDetails"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CarrierEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Carrier"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ServiceLevel":{"type":"object","properties":{"percentage":{"type":"number","format":"double"},"durationMs":{"type":"integer","format":"int64"}}},"ConsultTransferUpdate":{"type":"object","required":["speakTo"],"properties":{"speakTo":{"type":"string","description":"Determines to whom the initiating participant is speaking.","enum":["DESTINATION","OBJECT","BOTH"]}}},"User":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"displayName":{"type":"string"},"phoneNumber":{"type":"string"},"userImages":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"chat":{"$ref":"#/definitions/Chat"},"roles":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationRole"}},"voicemailEnabled":{"type":"boolean","default":false},"department":{"type":"string"},"title":{"type":"string"},"routingStatus":{"$ref":"#/definitions/RoutingStatus"},"password":{"type":"string"},"primaryPresence":{"$ref":"#/definitions/UserPresence"},"conversations":{"$ref":"#/definitions/UserConversationSummary"},"conversationSummary":{"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"$ref":"#/definitions/OutOfOffice"},"geolocation":{"$ref":"#/definitions/Geolocation"},"permissions":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"requestedStatus":{"$ref":"#/definitions/UserStatus"},"defaultStationUri":{"type":"string","format":"uri"},"stationUri":{"type":"string","format":"uri"},"lastStationUri":{"type":"string","format":"uri","readOnly":true}}},"FacetEntry":{"type":"object","properties":{"attribute":{"$ref":"#/definitions/TermAttribute"},"statistics":{"$ref":"#/definitions/FacetStatistics"},"other":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"},"missing":{"type":"integer","format":"int64"},"termCount":{"type":"integer","format":"int32"},"termType":{"type":"string","enum":["TERM","NUMBERRANGE","NUMBERHISTOGRAM","DATERANGE","DATEHISTOGRAM","ID"]},"terms":{"type":"array","items":{"$ref":"#/definitions/FacetTerm"}}}},"PhoneBaseEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/PhoneBase"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"HealthCheckInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"Build-Time":{"type":"string"},"Build-Version":{"type":"string"},"Build-Jdk":{"type":"string"},"Built-By":{"type":"string"},"Implementation-Build":{"type":"string"},"Implementation-Version":{"type":"string"},"Status":{"type":"string","enum":["OK","CREATED","ACCEPTED","NO_CONTENT","RESET_CONTENT","PARTIAL_CONTENT","MOVED_PERMANENTLY","FOUND","SEE_OTHER","NOT_MODIFIED","USE_PROXY","TEMPORARY_REDIRECT","BAD_REQUEST","UNAUTHORIZED","PAYMENT_REQUIRED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","NOT_ACCEPTABLE","PROXY_AUTHENTICATION_REQUIRED","REQUEST_TIMEOUT","CONFLICT","GONE","LENGTH_REQUIRED","PRECONDITION_FAILED","REQUEST_ENTITY_TOO_LARGE","REQUEST_URI_TOO_LONG","UNSUPPORTED_MEDIA_TYPE","REQUESTED_RANGE_NOT_SATISFIABLE","EXPECTATION_FAILED","INTERNAL_SERVER_ERROR","NOT_IMPLEMENTED","BAD_GATEWAY","SERVICE_UNAVAILABLE","GATEWAY_TIMEOUT","HTTP_VERSION_NOT_SUPPORTED"]},"Ping-Ms":{"type":"integer","format":"int32"},"Date":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"FacetRequest":{"type":"object","required":["facetRequestQueryType","fieldName","name"],"properties":{"name":{"type":"string","description":"name of the facet request that will be returned with the result set"},"facetRequestQueryType":{"type":"string","description":"Which facet request type","enum":["TERM","RANGE"]},"fieldName":{"type":"string","description":"The fieldName to perform the facet request on."},"type":{"type":"string","description":"the fieldtype of the field to perform the facet request on.","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST","GROUP"]},"rangeFrom":{"type":"string","description":"For RANGE requests populate this field to specify the beginning of a limit (leave blank for openended).  Note this value is inclusive of the results.  (EG if the value is 1, 1 will be included in the range.)"},"rangeTo":{"type":"string","description":"For RANGE requests populate this field to specify the end of a limit (leave blank for openended).  Note this value is EXCLUSIVE of the result (EG if this value was 5, only values LESS THAN 5 will be included in the count.)"},"maxFacetCount":{"type":"integer","format":"int32","description":"Limits/expands the number of facet entries returned (default 500)"}},"description":"Used as part of a searchRequest or reportRequest to denote which facets to generate from the search results.  For RANGE facets, one of rangeFrom or rangeTo (or both) MUST be set"},"CampaignStats":{"type":"object","properties":{"contactRate":{"$ref":"#/definitions/ConnectRate"},"idleAgents":{"type":"integer","format":"int32"},"adjustedCallsPerAgent":{"type":"number","format":"double"},"outstandingCalls":{"type":"integer","format":"int32"}}},"Segment":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"endTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"type":{"type":"string"},"howEnded":{"type":"string"},"disconnectType":{"type":"string"}}},"WorkItemCommandGroup":{"type":"object","properties":{"category":{"type":"string"},"defaultCommandId":{"type":"string"},"commands":{"type":"array","items":{"$ref":"#/definitions/WorkItemCommand"}}}},"ChatMessageUser":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"displayName":{"type":"string"},"username":{"type":"string"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}}}},"DomainEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DomainEntity"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SchemaCategory":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DigitLength":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}}},"TagValue":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"inUse":{"type":"boolean","default":false},"acl":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/User"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainPermission":{"type":"object","properties":{"domain":{"type":"string"},"entityType":{"type":"string"},"action":{"type":"string"},"label":{"type":"string"},"licenses":{"type":"array","items":{"type":"string"}},"allowsConditions":{"type":"boolean","default":false}}},"CreateShareResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"sharedEntityType":{"type":"string","enum":["DOCUMENT"]},"sharedEntity":{"$ref":"#/definitions/UriReference"},"memberType":{"type":"string","enum":["USER","PUBLIC"]},"member":{"$ref":"#/definitions/UriReference"},"sharedBy":{"$ref":"#/definitions/UriReference"},"workspace":{"$ref":"#/definitions/UriReference"},"succeeded":{"type":"array","items":{"$ref":"#/definitions/Share"}},"failed":{"type":"array","items":{"$ref":"#/definitions/Share"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowVersionEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/FlowVersion"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RunNowResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Service":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"status":{"type":"string"},"domains":{"type":"array","description":"An inbound carrier specific domain (i.e. lb.domain.com)","items":{"type":"string"}},"serviceTypes":{"type":"array","items":{"$ref":"#/definitions/ServiceType"}},"gateways":{"type":"array","items":{"$ref":"#/definitions/Gateway"}},"dns":{"$ref":"#/definitions/Dns"},"vpn":{"$ref":"#/definitions/Vpn"},"carrier":{"$ref":"#/definitions/Carrier"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Preview":{"type":"object","properties":{"id":{"type":"string"},"selfUri":{"type":"string"},"campaign":{"$ref":"#/definitions/Campaign"},"contactList":{"$ref":"#/definitions/ContactList"},"contact":{"$ref":"#/definitions/Contact"},"availablePhoneNumbers":{"type":"array","items":{"type":"string"}},"remainingSeconds":{"type":"integer","format":"int32"},"scriptId":{"type":"string"},"timedOut":{"type":"boolean","default":false}}},"Change":{"type":"object","properties":{"entity":{"$ref":"#/definitions/Entity"},"property":{"type":"string"},"oldValues":{"type":"array","items":{"type":"string"}},"newValues":{"type":"array","items":{"type":"string"}}}},"Contact":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"contactListId":{"type":"string"},"data":{"type":"object","additionalProperties":{"type":"object"}},"callRecords":{"type":"object","additionalProperties":{"$ref":"#/definitions/CallRecord"}},"callable":{"type":"boolean","default":false},"phoneNumberStatus":{"type":"object","additionalProperties":{"$ref":"#/definitions/PhoneNumberStatus"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallableTimeSetEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/CallableTimeSet"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Response":{"type":"object","required":["libraries","texts"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"libraries":{"type":"array","description":"One or more libraries response is associated with.","items":{"$ref":"#/definitions/UriReference"}},"texts":{"type":"array","description":"One or more texts associated with the response.","items":{"$ref":"#/definitions/ResponseText"}},"createdBy":{"description":"User that created the response","$ref":"#/definitions/User"},"dateCreated":{"type":"string","format":"date-time","description":"The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Contains information about a response."},"OrphanRecording":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"createdTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"recoveredTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"providerType":{"type":"string","enum":["EDGE","CHAT","EMAIL"]},"mediaSizeBytes":{"type":"integer","format":"int64"},"mediaType":{"type":"string","enum":["CALL","CHAT","EMAIL"]},"fileState":{"type":"string","enum":["ARCHIVED","AVAILABLE","DELETED","RESTORED","RESTORING","UPLOADING"]},"providerEndpoint":{"$ref":"#/definitions/Endpoint"},"recording":{"$ref":"#/definitions/Recording"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PureCloud":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhoneEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Phone"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DialerCall":{"type":"object","properties":{"callId":{"type":"string"},"conversationId":{"type":"string"}}},"MediaPolicy":{"type":"object","properties":{"evaluationCriteria":{"type":"array","description":"When conditions are evaluation and actions applied","items":{"type":"string","enum":["CONVERSATION_COMPLETE","PER_CONVERSATION_EVENT"]}},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/PolicyConditions"},"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"}}},"Session":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"minutesToLive":{"type":"integer","format":"int64"},"userAgent":{"type":"string"},"createdOn":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"user":{"$ref":"#/definitions/User"},"language":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}}},"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"externalDocs":{"description":"PureCloud API Documentation","url":"https://developer.mypurecloud.com"}}
\ No newline at end of file