swagger.json in purecloud-0.43.1 vs swagger.json in purecloud-0.44.1

@@ -1 +1 @@
-{"swagger":"2.0","info":{"description":"With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.","version":"v2","title":"PureCloud Platform API","termsOfService":"https://developer.mypurecloud.com/tos","contact":{"name":"PureCloud Developer Evangelists","url":"https://developer.mypurecloud.com","email":"[e-mail]"},"license":{"name":"ININ","url":"http://www.inin.com"}},"host":"api.mypurecloud.com","tags":[{"name":"Alerting","description":"Rules and alerts"},{"name":"Analytics","description":"Analytics querying and reporting.","externalDocs":{"description":"analytics docs","url":"https://developer.mypurecloud.com/analytics"}},{"name":"Attributes","description":"Attribute definitions"},{"name":"Authorization","description":"Roles and permissions","externalDocs":{"description":"authorization docs","url":"https://developer.mypurecloud.com/authorization"}},{"name":"Configuration","description":""},{"name":"Content Management","description":""},{"name":"Conversations","description":""},{"name":"Calls","description":""},{"name":"Callbacks","description":""},{"name":"Chats","description":""},{"name":"Emails","description":""},{"name":"Faxes","description":""},{"name":"Socials","description":""},{"name":"Videos","description":""},{"name":"Directory Proxy","description":"Search, Suggest, and people"},{"name":"Docs","description":"Swagger documentation definitions","externalDocs":{"description":"docs","url":"https://developer.mypurecloud.com"}},{"name":"Fax","description":""},{"name":"Geolocation","description":""},{"name":"Greetings","description":""},{"name":"Groups","description":"Groups, members"},{"name":"Identity Provider","description":"Identity providers"},{"name":"Languages","description":"Available languages"},{"name":"Locations","description":"Physical locations"},{"name":"Notifications","description":"Channels, subscriptions, topics"},{"name":"OAuth","description":"OAuth clients, providers"},{"name":"Organization","description":"Organization"},{"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":"Search","description":"Search aggregate, users, groups"},{"name":"Suggest","description":"Search suggest user, group, locations"},{"name":"Sessions","description":"User session"},{"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/v2/alerting/interactionstats/alerts":{"get":{"tags":["Alerting"],"summary":"Get interaction stats alert list.","description":"","operationId":"getInteractionstatsAlerts","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsAlertContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getInteractionstatsAlerts"}},"/api/v2/alerting/interactionstats/alerts/unread":{"get":{"tags":["Alerting"],"summary":"Gets user unread count of interaction stats alerts.","description":"","operationId":"getInteractionstatsAlertsUnread","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnreadMetric"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getInteractionstatsAlertsUnread"}},"/api/v2/alerting/interactionstats/alerts/{alertId}":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats alert","description":"","operationId":"getInteractionstatsAlertsAlertId","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsAlert"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getInteractionstatsAlertsAlertId"},"put":{"tags":["Alerting"],"summary":"Update an interaction stats alert read status","description":"","operationId":"putInteractionstatsAlertsAlertId","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"},{"in":"body","name":"body","description":"InteractionStatsAlert","required":false,"schema":{"$ref":"#/definitions/UnreadStatus"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnreadStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putInteractionstatsAlertsAlertId"},"delete":{"tags":["Alerting"],"summary":"Delete an interaction stats alert","description":"","operationId":"deleteInteractionstatsAlertsAlertId","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert 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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteInteractionstatsAlertsAlertId"}},"/api/v2/alerting/interactionstats/rules":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats rule list.","description":"","operationId":"getInteractionstatsRules","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRuleContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getInteractionstatsRules"},"post":{"tags":["Alerting"],"summary":"Create an interaction stats rule.","description":"","operationId":"postInteractionstatsRules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"AlertingRule","required":false,"schema":{"$ref":"#/definitions/InteractionStatsRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postInteractionstatsRules"}},"/api/v2/alerting/interactionstats/rules/{ruleId}":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats rule.","description":"","operationId":"getInteractionstatsRulesRuleId","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getInteractionstatsRulesRuleId"},"put":{"tags":["Alerting"],"summary":"Update an interaction stats rule","description":"","operationId":"putInteractionstatsRulesRuleId","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule ID","required":true,"type":"string"},{"in":"body","name":"body","description":"AlertingRule","required":false,"schema":{"$ref":"#/definitions/InteractionStatsRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putInteractionstatsRulesRuleId"},"delete":{"tags":["Alerting"],"summary":"Delete an interaction stats rule.","description":"","operationId":"deleteInteractionstatsRulesRuleId","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule 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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteInteractionstatsRulesRuleId"}},"/api/v2/analytics/conversations/aggregates/query":{"post":{"tags":["Conversations","Analytics"],"summary":"Query for conversation aggregates","description":"","operationId":"postConversationsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":false,"schema":{"$ref":"#/definitions/AggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required.field.missing":"A required field is missing a value."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationsAggregatesQuery"}},"/api/v2/analytics/conversations/details/query":{"post":{"tags":["Conversations","Analytics"],"summary":"Query for conversation details","description":"","operationId":"postConversationsDetailsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":false,"schema":{"$ref":"#/definitions/ConversationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationsDetailsQuery"}},"/api/v2/analytics/conversations/{conversationId}/details":{"get":{"tags":["Conversations","Analytics"],"summary":"Get a conversation by id","description":"","operationId":"getConversationsConversationIdDetails","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationsConversationIdDetails"}},"/api/v2/analytics/conversations/{conversationId}/details/properties":{"post":{"tags":["Conversations","Analytics"],"summary":"Index conversation properties","description":"","operationId":"postConversationsConversationIdDetailsProperties","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"request","required":false,"schema":{"$ref":"#/definitions/PropertyIndexRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PropertyIndexRequest"}},"202":{"description":"Accepted - Indexing properties"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationsConversationIdDetailsProperties"}},"/api/v2/analytics/evaluations/aggregates/query":{"post":{"tags":["Quality","Analytics"],"summary":"Query for evaluation aggregates","description":"","operationId":"postEvaluationsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":false,"schema":{"$ref":"#/definitions/AggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEvaluationsAggregatesQuery"}},"/api/v2/analytics/queues/observations/query":{"post":{"tags":["Routing","Analytics"],"summary":"Query for queue observations","description":"","operationId":"postQueuesObservationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":false,"schema":{"$ref":"#/definitions/ObservationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ObservationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQueuesObservationsQuery"}},"/api/v2/analytics/reporting/metadata":{"get":{"tags":["Analytics"],"summary":"Get list of reporting metadata.","description":"","operationId":"getReportingMetadata","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":"locale","in":"query","description":"Locale","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportMetaDataEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getReportingMetadata"}},"/api/v2/analytics/reporting/reportformats":{"get":{"tags":["Analytics"],"summary":"Get a list of report formats","description":"Get a list of report formats.","operationId":"getReportingReportformats","produces":["application/json"],"parameters":[],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getReportingReportformats"}},"/api/v2/analytics/reporting/schedules":{"get":{"tags":["Analytics"],"summary":"Get a list of scheduled report jobs","description":"Get a list of scheduled report jobs.","operationId":"getReportingSchedules","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/ReportScheduleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getReportingSchedules"},"post":{"tags":["Analytics"],"summary":"Create a scheduled report job","description":"Create a scheduled report job.","operationId":"postReportingSchedules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ReportSchedule","required":false,"schema":{"$ref":"#/definitions/ReportSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postReportingSchedules"}},"/api/v2/analytics/reporting/schedules/{scheduleId}":{"get":{"tags":["Analytics"],"summary":"Get a scheduled report job.","description":"","operationId":"getReportingSchedulesScheduleId","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getReportingSchedulesScheduleId"},"put":{"tags":["Analytics"],"summary":"Update a scheduled report job.","description":"","operationId":"putReportingSchedulesScheduleId","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ReportSchedule","required":false,"schema":{"$ref":"#/definitions/ReportSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putReportingSchedulesScheduleId"},"delete":{"tags":["Analytics"],"summary":"Delete a scheduled report job.","description":"","operationId":"deleteReportingSchedulesScheduleId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteReportingSchedulesScheduleId"}},"/api/v2/analytics/reporting/schedules/{scheduleId}/history":{"get":{"tags":["Analytics"],"summary":"Get list of completed scheduled report jobs.","description":"","operationId":"getReportingSchedulesScheduleIdHistory","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportRunEntryEntityDomainListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getReportingSchedulesScheduleIdHistory"}},"/api/v2/analytics/reporting/schedules/{scheduleId}/history/latest":{"get":{"tags":["Analytics"],"summary":"Get most recently completed scheduled report job.","description":"","operationId":"getReportingSchedulesScheduleIdHistoryLatest","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportRunEntry"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getReportingSchedulesScheduleIdHistoryLatest"}},"/api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId}":{"get":{"tags":["Analytics"],"summary":"A completed scheduled report job","description":"A completed scheduled report job.","operationId":"getReportingSchedulesScheduleIdHistoryRunId","produces":["application/json"],"parameters":[{"name":"runId","in":"path","description":"Run ID","required":true,"type":"string"},{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportRunEntry"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getReportingSchedulesScheduleIdHistoryRunId"}},"/api/v2/analytics/reporting/schedules/{scheduleId}/runreport":{"post":{"tags":["Analytics"],"summary":"Place a scheduled report immediately into the reporting queue","description":"","operationId":"postReportingSchedulesScheduleIdRunreport","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RunNowResponse"}},"202":{"description":"Accepted - Processing Report"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postReportingSchedulesScheduleIdRunreport"}},"/api/v2/analytics/reporting/timeperiods":{"get":{"tags":["Analytics"],"summary":"Get a list of report time periods.","description":"","operationId":"getReportingTimeperiods","produces":["application/json"],"parameters":[],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getReportingTimeperiods"}},"/api/v2/analytics/reporting/{reportId}/metadata":{"get":{"tags":["Analytics"],"summary":"Get a reporting metadata.","description":"","operationId":"getReportingReportIdMetadata","produces":["application/json"],"parameters":[{"name":"reportId","in":"path","description":"Report ID","required":true,"type":"string"},{"name":"locale","in":"query","description":"Locale","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportMetaData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getReportingReportIdMetadata"}},"/api/v2/analytics/users/aggregates/query":{"post":{"tags":["Users","Analytics"],"summary":"Query for user aggregates","description":"","operationId":"postUsersAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":false,"schema":{"$ref":"#/definitions/AggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PresenceQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postUsersAggregatesQuery"}},"/api/v2/analytics/users/observations/query":{"post":{"tags":["Users","Analytics"],"summary":"Query for user observations","description":"","operationId":"postUsersObservationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":false,"schema":{"$ref":"#/definitions/ObservationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ObservationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postUsersObservationsQuery"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postAttributes"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQuery"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"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"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteAttributeId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPermissions"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProducts"}},"/api/v2/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":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRoles"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRolesDefault"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRolesLeftroleIdComparedefaultRightroleId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchRolesRoleId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRolesRoleIdUsersAdd"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRolesRoleIdUsersRemove"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDetails"}},"/api/v2/configuration/schemas/edges/vnext":{"get":{"tags":["Telephony Providers Edge"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchemasEdgesVnext"}},"/api/v2/configuration/schemas/edges/vnext/{schemaCategory}":{"get":{"tags":["Telephony Providers Edge"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchemasEdgesVnextSchemacategory"}},"/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}":{"get":{"tags":["Telephony Providers Edge"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchemasEdgesVnextSchemacategorySchematype"}},"/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}":{"get":{"tags":["Telephony Providers Edge"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchemasEdgesVnextSchemacategorySchematypeSchemaId"}},"/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}/{extensionType}/{metadataId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get metadata for a schema","description":"","operationId":"getSchemasEdgesVnextSchemacategorySchematypeSchemaIdExtensiontypeMetadataId","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":"extensionType","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchemasEdgesVnextSchemacategorySchematypeSchemaIdExtensiontypeMetadataId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postAuditquery"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The source document is locked by another operation"},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDocuments"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"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"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteDocumentsDocumentId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDocumentsDocumentIdAudits"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"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"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDocumentsDocumentIdContent"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQuery"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSecurityprofiles"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSecurityprofilesSecurityprofileId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSharedSharedId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postShares"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSharesShareId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getStatus"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteStatusStatusId"}},"/api/v2/contentmanagement/usage":{"get":{"tags":["Content Management"],"summary":"Get usage details.","description":"","operationId":"getUsage","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Usage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUsage"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postWorkspaces"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteWorkspacesWorkspaceId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getWorkspacesWorkspaceIdMembers"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteWorkspacesWorkspaceIdMembersMemberId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postWorkspacesWorkspaceIdTagvalues"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postWorkspacesWorkspaceIdTagvaluesQuery"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteWorkspacesWorkspaceIdTagvaluesTagId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversations"}},"/api/v2/conversations/callbacks":{"get":{"tags":["Conversations"],"summary":"Get callback conversations","description":"","operationId":"getCallbacks","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallbackConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallbacks"},"post":{"tags":["Conversations"],"summary":"Create a Callback","description":"","operationId":"postCallbacks","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateCallbackCommand"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateCallbackResponse"}},"202":{"description":"Accepted - Creating and Processing a Callback"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallbacks"}},"/api/v2/conversations/callbacks/{callbackId}":{"get":{"tags":["Conversations"],"summary":"Get callback conversation","description":"","operationId":"getCallbacksCallbackId","produces":["application/json"],"parameters":[{"name":"callbackId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallbackConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallbacksCallbackId"}},"/api/v2/conversations/callbacks/{callbackId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchCallbacksCallbackIdParticipantsParticipantId","produces":["application/json"],"parameters":[{"name":"callbackId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchCallbacksCallbackIdParticipantsParticipantId"}},"/api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchCallbacksCallbackIdParticipantsParticipantIdAttributes","produces":["application/json"],"parameters":[{"name":"callbackId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchCallbacksCallbackIdParticipantsParticipantIdAttributes"}},"/api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postCallbacksCallbackIdParticipantsParticipantIdReplace","produces":["application/json"],"parameters":[{"name":"callbackId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallbacksCallbackIdParticipantsParticipantIdReplace"}},"/api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getCallbacksCallbackIdParticipantsParticipantIdWrapup","produces":["application/json"],"parameters":[{"name":"callbackId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallbacksCallbackIdParticipantsParticipantIdWrapup"}},"/api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getCallbacksCallbackIdParticipantsParticipantIdWrapupcodes","produces":["application/json"],"parameters":[{"name":"callbackId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallbacksCallbackIdParticipantsParticipantIdWrapupcodes"}},"/api/v2/conversations/calls":{"get":{"tags":["Conversations"],"summary":"Get recent conversations","description":"","operationId":"getCalls","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCalls"},"post":{"tags":["Conversations"],"summary":"Create a call conversation","description":"","operationId":"postCalls","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateCallRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateCallResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","conversation.error.no.user.station":"A station is required to place a call.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCalls"}},"/api/v2/conversations/calls/history":{"get":{"tags":["Conversations"],"summary":"Get call history","description":"","operationId":"getCallsHistory","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":"interval","in":"query","description":"Interval string; format is ISO-8601. Separate start and end times with forward slash '/'","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallsHistory"}},"/api/v2/conversations/calls/maximumconferenceparties":{"get":{"tags":["Conversations"],"summary":"Get the maximum number of participants that this user can have on a conference","description":"","operationId":"getCallsMaximumconferenceparties","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallsMaximumconferenceparties"}},"/api/v2/conversations/calls/{callId}":{"get":{"tags":["Conversations"],"summary":"Get call conversation","description":"","operationId":"getCallsCallId","produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallsCallId"},"post":{"tags":["Conversations"],"summary":"Add a new call to a conversation","description":"","operationId":"postCallsCallId","produces":["application/json"],"parameters":[{"name":"callId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallsCallId"},"patch":{"tags":["Conversations"],"summary":"Update conversation","description":"","operationId":"patchCallsCallId","produces":["application/json"],"parameters":[{"name":"callId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchCallsCallId"}},"/api/v2/conversations/calls/{callId}/participants":{"post":{"tags":["Conversations"],"summary":"Add participants to a conversation","description":"","operationId":"postCallsCallIdParticipants","produces":["application/json"],"parameters":[{"name":"callId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallsCallIdParticipants"}},"/api/v2/conversations/calls/{callId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchCallsCallIdParticipantsParticipantId","produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchCallsCallIdParticipantsParticipantId"}},"/api/v2/conversations/calls/{callId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchCallsCallIdParticipantsParticipantIdAttributes","produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchCallsCallIdParticipantsParticipantIdAttributes"}},"/api/v2/conversations/calls/{callId}/participants/{participantId}/consult":{"post":{"tags":["Conversations"],"summary":"Initiate and update consult transfer","description":"","operationId":"postCallsCallIdParticipantsParticipantIdConsult","produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallsCallIdParticipantsParticipantIdConsult"},"delete":{"tags":["Conversations"],"summary":"Cancel the transfer","description":"","operationId":"deleteCallsCallIdParticipantsParticipantIdConsult","produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCallsCallIdParticipantsParticipantIdConsult"},"patch":{"tags":["Conversations"],"summary":"Change who can speak","description":"","operationId":"patchCallsCallIdParticipantsParticipantIdConsult","produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchCallsCallIdParticipantsParticipantIdConsult"}},"/api/v2/conversations/calls/{callId}/participants/{participantId}/monitor":{"post":{"tags":["Conversations"],"summary":"Listen in on the conversation from the point of view of a given participant.","description":"","operationId":"postCallsCallIdParticipantsParticipantIdMonitor","produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","conversation.error.monitor.own.conversation":"A user cannot monitor a conversation where they are an active participant.","conversation.error.no.user.station":"A station is required to place a call.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallsCallIdParticipantsParticipantIdMonitor"}},"/api/v2/conversations/calls/{callId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postCallsCallIdParticipantsParticipantIdReplace","produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallsCallIdParticipantsParticipantIdReplace"}},"/api/v2/conversations/calls/{callId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getCallsCallIdParticipantsParticipantIdWrapup","produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallsCallIdParticipantsParticipantIdWrapup"}},"/api/v2/conversations/calls/{callId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getCallsCallIdParticipantsParticipantIdWrapupcodes","produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallsCallIdParticipantsParticipantIdWrapupcodes"}},"/api/v2/conversations/chats":{"get":{"tags":["Conversations"],"summary":"Get recent chat conversations","description":"","operationId":"getChats","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getChats"}},"/api/v2/conversations/chats/{chatId}":{"get":{"tags":["Conversations"],"summary":"Get chat conversation","description":"","operationId":"getChatsChatId","produces":["application/json"],"parameters":[{"name":"chatId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getChatsChatId"}},"/api/v2/conversations/chats/{chatId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchChatsChatIdParticipantsParticipantId","produces":["application/json"],"parameters":[{"name":"chatId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchChatsChatIdParticipantsParticipantId"}},"/api/v2/conversations/chats/{chatId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchChatsChatIdParticipantsParticipantIdAttributes","produces":["application/json"],"parameters":[{"name":"chatId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchChatsChatIdParticipantsParticipantIdAttributes"}},"/api/v2/conversations/chats/{chatId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postChatsChatIdParticipantsParticipantIdReplace","produces":["application/json"],"parameters":[{"name":"chatId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postChatsChatIdParticipantsParticipantIdReplace"}},"/api/v2/conversations/chats/{chatId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getChatsChatIdParticipantsParticipantIdWrapup","produces":["application/json"],"parameters":[{"name":"chatId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getChatsChatIdParticipantsParticipantIdWrapup"}},"/api/v2/conversations/chats/{chatId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getChatsChatIdParticipantsParticipantIdWrapupcodes","produces":["application/json"],"parameters":[{"name":"chatId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getChatsChatIdParticipantsParticipantIdWrapupcodes"}},"/api/v2/conversations/emails":{"get":{"tags":["Conversations"],"summary":"Get recent email conversations","description":"","operationId":"getEmails","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmails"}},"/api/v2/conversations/emails/{emailId}":{"get":{"tags":["Conversations"],"summary":"Get email conversation","description":"","operationId":"getEmailsEmailId","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailsEmailId"}},"/api/v2/conversations/emails/{emailId}/messages":{"get":{"tags":["Conversations"],"summary":"Get conversation messages","description":"","operationId":"getEmailsEmailIdMessages","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailsEmailIdMessages"},"post":{"tags":["Conversations"],"summary":"Send an email reply","description":"","operationId":"postEmailsEmailIdMessages","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEmailsEmailIdMessages"}},"/api/v2/conversations/emails/{emailId}/messages/draft":{"get":{"tags":["Conversations"],"summary":"Get conversation draft reply","description":"","operationId":"getEmailsEmailIdMessagesDraft","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailsEmailIdMessagesDraft"},"put":{"tags":["Conversations"],"summary":"Update conversation draft reply","description":"","operationId":"putEmailsEmailIdMessagesDraft","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putEmailsEmailIdMessagesDraft"}},"/api/v2/conversations/emails/{emailId}/messages/draft/attachments/{attachmentId}":{"delete":{"tags":["Conversations"],"summary":"Delete attachment from draft","description":"","operationId":"deleteEmailsEmailIdMessagesDraftAttachmentsAttachmentId","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","required":true,"type":"string"},{"name":"attachmentId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteEmailsEmailIdMessagesDraftAttachmentsAttachmentId"}},"/api/v2/conversations/emails/{emailId}/messages/{messageId}":{"get":{"tags":["Conversations"],"summary":"Get conversation message","description":"","operationId":"getEmailsEmailIdMessagesMessageId","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","required":true,"type":"string"},{"name":"messageId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailsEmailIdMessagesMessageId"}},"/api/v2/conversations/emails/{emailId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchEmailsEmailIdParticipantsParticipantId","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchEmailsEmailIdParticipantsParticipantId"}},"/api/v2/conversations/emails/{emailId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchEmailsEmailIdParticipantsParticipantIdAttributes","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchEmailsEmailIdParticipantsParticipantIdAttributes"}},"/api/v2/conversations/emails/{emailId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postEmailsEmailIdParticipantsParticipantIdReplace","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEmailsEmailIdParticipantsParticipantIdReplace"}},"/api/v2/conversations/emails/{emailId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getEmailsEmailIdParticipantsParticipantIdWrapup","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailsEmailIdParticipantsParticipantIdWrapup"}},"/api/v2/conversations/emails/{emailId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getEmailsEmailIdParticipantsParticipantIdWrapupcodes","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailsEmailIdParticipantsParticipantIdWrapupcodes"}},"/api/v2/conversations/faxes":{"post":{"tags":["Conversations"],"summary":"Create Fax Conversation","description":"","operationId":"postFaxes","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","fax.content.type.not.supported":"The fax content type is not supported.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"fax.forbidden":"You are not permitted to send faxes.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postFaxes"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationId"}},"/api/v2/conversations/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update a participant.","description":"Update conversation participant.","operationId":"patchConversationIdParticipantsParticipantId","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/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchConversationIdParticipantsParticipantId"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationIdParticipantsParticipantIdAttributes","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchConversationIdParticipantsParticipantIdAttributes"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdParticipantsParticipantIdCallbacks"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode}":{"delete":{"tags":["Conversations"],"summary":"Delete a code used to add a communication to this participant","description":"","operationId":"deleteConversationIdParticipantsParticipantIdCodesAddcommunicationcode","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":"addCommunicationCode","in":"path","description":"addCommunicationCode","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteConversationIdParticipantsParticipantIdCodesAddcommunicationcode"}},"/api/v2/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"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdParticipantsParticipantIdReplace"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdParticipantsParticipantIdWrapup"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdParticipantsParticipantIdWrapupcodes"}},"/api/v2/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 media format","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","NONE"]}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdRecordings"}},"/api/v2/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":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","NONE"]},{"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"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"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putConversationIdRecordingsRecordingId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdRecordingsRecordingIdAnnotations"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteConversationIdRecordingsRecordingIdAnnotationsAnnotationId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDate"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDocuments"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteDocumentsDocumentId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDocumentsDocumentIdContent"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSummary"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchSettings"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postGreetings"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putDefaults"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteGreetingId"}},"/api/v2/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 media format.","required":false,"type":"string","default":"WAV","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","NONE"]}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getGreetingIdMedia"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getGroups"},"post":{"tags":["Groups"],"summary":"Create a group","description":"","operationId":"postGroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Group"}}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postGroups"}},"/api/v2/groups/search":{"get":{"tags":["Groups","Search"],"summary":"Search using q64","description":"","operationId":"getSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","required":false,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSearch"},"post":{"tags":["Groups","Search"],"summary":"Search","description":"","operationId":"postSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":false,"schema":{"$ref":"#/definitions/GroupSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSearch"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getGroupId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getGroupIdMembers"},"post":{"tags":["Groups"],"summary":"Add members","description":"","operationId":"postGroupIdMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Add members","required":false,"schema":{"$ref":"#/definitions/GroupMembersUpdate"}}],"responses":{"202":{"description":"Success, group membership was updated"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postGroupIdMembers"},"delete":{"tags":["Groups"],"summary":"Remove members","description":"","operationId":"deleteGroupIdMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"ids","in":"query","description":"Comma separated list of userIds to remove","required":true,"type":"string"}],"responses":{"202":{"description":"Success, group membership was updated"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteGroupIdMembers"}},"/api/v2/identityproviders":{"get":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getIdentityproviders"}},"/api/v2/identityproviders/adfs":{"get":{"tags":["Identity Provider"],"summary":"Get ADFS Identity Provider","description":"","operationId":"getAdfs","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ADFS"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getAdfs"},"put":{"tags":["Identity Provider"],"summary":"Update/Create ADFS Identity Provider","description":"","operationId":"putAdfs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":false,"schema":{"$ref":"#/definitions/ADFS"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putAdfs"},"delete":{"tags":["Identity Provider"],"summary":"Delete ADFS Identity Provider","description":"","operationId":"deleteAdfs","produces":["application/json"],"parameters":[],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteAdfs"}},"/api/v2/identityproviders/cic":{"get":{"tags":["Identity Provider"],"summary":"Get Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"getCic","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CustomerInteractionCenter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCic"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"putCic","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":false,"schema":{"$ref":"#/definitions/CustomerInteractionCenter"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putCic"},"delete":{"tags":["Identity Provider"],"summary":"Delete Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"deleteCic","produces":["application/json"],"parameters":[],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCic"}},"/api/v2/identityproviders/okta":{"get":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOkta"},"put":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putOkta"},"delete":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteOkta"}},"/api/v2/identityproviders/onelogin":{"get":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOnelogin"},"put":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putOnelogin"},"delete":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteOnelogin"}},"/api/v2/identityproviders/purecloud":{"get":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPurecloud"},"put":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putPurecloud"},"delete":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deletePurecloud"}},"/api/v2/identityproviders/salesforce":{"get":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSalesforce"},"put":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSalesforce"},"delete":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSalesforce"}},"/api/v2/identityproviders/{providerId}":{"get":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProviderId"},"put":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProviderId"},"delete":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProviderId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLanguages"},"post":{"tags":["Languages"],"summary":"Create Language","description":"","operationId":"postLanguages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Language","required":false,"schema":{"$ref":"#/definitions/Language"}}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postLanguages"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLanguageId"},"put":{"tags":["Languages"],"summary":"Update Language","description":"","operationId":"putLanguageId","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Language","required":false,"schema":{"$ref":"#/definitions/Language"}}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putLanguageId"},"delete":{"tags":["Languages"],"summary":"Delete Language","description":"","operationId":"deleteLanguageId","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language 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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteLanguageId"}},"/api/v2/locations":{"get":{"tags":["Locations"],"summary":"Get a list of all locations.","description":"","operationId":"getLocations","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":"Sort order","required":false,"type":"string","enum":["asc","desc"]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Location"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLocations"}},"/api/v2/locations/search":{"get":{"tags":["Search","Locations"],"summary":"Search using q64","description":"","operationId":"getSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","required":false,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSearch"},"post":{"tags":["Search","Locations"],"summary":"Search","description":"","operationId":"postSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":false,"schema":{"$ref":"#/definitions/LocationSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSearch"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLocationId"}},"/api/v2/notifications/availabletopics":{"get":{"tags":["Notifications"],"summary":"Get available notification topics.","description":"","operationId":"getAvailabletopics","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["description","schema"]},"collectionFormat":"multi"}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getAvailabletopics"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postChannels"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","notification.invalid.topic":"The subscription topic is not valid."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","notification.invalid.topic":"The subscription topic is not valid."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteChannelsChannelIdSubscriptions"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postClients"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteClientsClientId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postClientsClientIdSecret"}},"/api/v2/organizations/me":{"get":{"tags":["Organization"],"summary":"Get organization.","description":"","operationId":"getMe","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMe"}},"/api/v2/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"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrphanrecordings"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteOrphanId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postAudits"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallabletimesets"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCallabletimesetsCallabletimesetId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallanalysisresponsesets"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","call.analysis.response.set.in.use":"The dialer call analysis response set is in use.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCallanalysisresponsesetsCallanalysissetId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCampaigns"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCampaignsProgress"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","edge.group.has.no.active.edges":"","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.update":"","invalid.update.bad.status.transition":"","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","campaign.in.use":"The campaign is in use.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCampaignsCampaignId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putCampaignsCampaignIdAgentsUserId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCampaignsCampaignIdCallbackSchedule"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCampaignsCampaignIdDiagnostics"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCampaignsCampaignIdProgress"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCampaignsCampaignIdStats"}},"/api/v2/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":"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postContactlists"}},"/api/v2/outbound/contactlists/{contactListId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer contact list.","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":"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The dialer contact list was not found.","not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","contact.list.in.use":"The contact list is in use.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteContactlistsContactlistId"}},"/api/v2/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/DialerContact"}}},{"name":"priority","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.contact.columns":"The contact columns are invalid.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postContactlistsContactlistIdContacts"}},"/api/v2/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/DialerContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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/DialerContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteContactlistsContactlistIdContactsContactId"}},"/api/v2/outbound/contactlists/{contactListId}/export":{"get":{"tags":["Outbound"],"summary":"Get the URI of a contact list export.","description":"","operationId":"getContactlistsContactlistIdExport","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"name":"download","in":"query","description":"Redirect to download uri","required":false,"type":"string","default":"false"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExportUri"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContactlistsContactlistIdExport"},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postContactlistsContactlistIdExport"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContactlistsContactlistIdImportstatus"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationsConversationIdDnc"}},"/api/v2/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":"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDnclists"}},"/api/v2/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":"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The dialer DNC list was not found.","not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","dnc.list.in.use":"The dialer DNC list is in use.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteDnclistsDnclistId"}},"/api/v2/outbound/dnclists/{dncListId}/export":{"get":{"tags":["Outbound"],"summary":"Get the URI of a DNC list export.","description":"","operationId":"getDnclistsDnclistIdExport","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"download","in":"query","description":"Redirect to download uri","required":false,"type":"string","default":"false"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExportUri"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDnclistsDnclistIdExport"},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDnclistsDnclistIdExport"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDnclistsDnclistIdImportstatus"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDnclistsDnclistIdPhonenumbers"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRulesets"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteRulesetsRulesetId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchedulesCampaigns"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.not.found":"The dialer campaign was not found.","not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSchedulesCampaignsCampaignId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchedulesSequences"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSchedulesSequencesSequenceId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"A campaign sequence with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSequences"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","campaign.sequence.is.empty":"The dialer campaign sequence is empty.","campaign.sequence.missing.campaign":"The dialer campaign sequence is missing the campaign.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSequencesSequenceId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putWrapupcodemappings"}},"/api/v2/presencedefinitions":{"get":{"tags":["Presence"],"summary":"Get an Organization's list of Presence Definitions","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"},{"name":"deleted","in":"query","description":"Deleted query can be true, false or all","required":false,"type":"string","default":"false"}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPresencedefinitions"},"post":{"tags":["Presence"],"summary":"Create a Presence Definition","description":"","operationId":"postPresencedefinitions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Presence Definition 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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postPresencedefinitions"}},"/api/v2/presencedefinitions/{presenceId}":{"get":{"tags":["Presence"],"summary":"Get a Presence Definition","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPresenceId"},"put":{"tags":["Presence"],"summary":"Update a Presence Definition","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putPresenceId"},"delete":{"tags":["Presence"],"summary":"Delete a Presence Definition","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deletePresenceId"}},"/api/v2/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":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getAgentsActivity"}},"/api/v2/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":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"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":true,"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCalibrations"}},"/api/v2/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":true,"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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":true,"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCalibrationsCalibrationId"}},"/api/v2/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":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationsConversationIdAudits"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationsConversationIdEvaluations"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteConversationsConversationIdEvaluationsEvaluationId"}},"/api/v2/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":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEvaluationsQuery"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEvaluationsScoring"}},"/api/v2/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":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEvaluatorsActivity"}},"/api/v2/quality/forms":{"get":{"tags":["Quality"],"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":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getForms"},"post":{"tags":["Quality"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postForms"}},"/api/v2/quality/forms/{formId}":{"get":{"tags":["Quality"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFormsFormId"},"put":{"tags":["Quality"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putFormsFormId"},"delete":{"tags":["Quality"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteFormsFormId"}},"/api/v2/quality/forms/{formId}/versions":{"get":{"tags":["Quality"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFormsFormIdVersions"}},"/api/v2/quality/keywordsets":{"get":{"tags":["Quality"],"summary":"Get the list of keyword sets","description":"","operationId":"getKeywordsets","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":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"name","in":"query","description":"the keyword set name - used for filtering results in searches.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeywordSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getKeywordsets"},"post":{"tags":["Quality"],"summary":"Create a Keyword Set","description":"","operationId":"postKeywordsets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"keywordSet","required":false,"schema":{"$ref":"#/definitions/KeywordSet"}},{"name":"expand","in":"query","description":"queueId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeywordSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postKeywordsets"},"delete":{"tags":["Quality"],"summary":"Delete keyword sets","description":"Bulk delete of keyword sets; this will only delete the keyword sets that match the ids specified in the query param.","operationId":"deleteKeywordsets","produces":["application/json"],"parameters":[{"name":"ids","in":"query","description":"A comma-delimited list of valid KeywordSet ids","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteKeywordsets"}},"/api/v2/quality/keywordsets/{keywordSetId}":{"get":{"tags":["Quality"],"summary":"Get a keywordSet by id.","description":"","operationId":"getKeywordsetsKeywordsetId","produces":["application/json"],"parameters":[{"name":"keywordSetId","in":"path","description":"KeywordSet ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeywordSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getKeywordsetsKeywordsetId"},"put":{"tags":["Quality"],"summary":"Update a keywordSet to the specified keywordSet via PUT.","description":"","operationId":"putKeywordsetsKeywordsetId","produces":["application/json"],"parameters":[{"name":"keywordSetId","in":"path","description":"KeywordSet ID","required":true,"type":"string"},{"in":"body","name":"body","description":"keywordSet","required":false,"schema":{"$ref":"#/definitions/KeywordSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeywordSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putKeywordsetsKeywordsetId"},"delete":{"tags":["Quality"],"summary":"Delete a keywordSet by id.","description":"","operationId":"deleteKeywordsetsKeywordsetId","produces":["application/json"],"parameters":[{"name":"keywordSetId","in":"path","description":"KeywordSet 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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteKeywordsetsKeywordsetId"}},"/api/v2/quality/publishedforms":{"get":{"tags":["Quality"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPublishedforms"},"post":{"tags":["Quality"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postPublishedforms"}},"/api/v2/quality/publishedforms/{formId}":{"get":{"tags":["Quality"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPublishedformsFormId"}},"/api/v2/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":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteMediaretentionpolicies"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchMediaretentionpoliciesPolicyId"}},"/api/v2/recording/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRecordingkeys"}},"/api/v2/recording/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRecordingkeysRotationschedule"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSettings"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postLibraries"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"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"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteLibrariesLibraryId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postResponses"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postResponsesQuery"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"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"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteResponsesResponseId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEmailDomains"}},"/api/v2/routing/email/domains/{domainId}":{"delete":{"tags":["Routing"],"summary":"Delete a domain","description":"","operationId":"deleteEmailDomainsDomainId","produces":["application/json"],"parameters":[{"name":"domainId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteEmailDomainsDomainId"}},"/api/v2/routing/email/domains/{domainName}/routes":{"get":{"tags":["Routing"],"summary":"Get routes","description":"","operationId":"getEmailDomainsDomainnameRoutes","produces":["application/json"],"parameters":[{"name":"domainName","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailDomainsDomainnameRoutes"},"post":{"tags":["Routing"],"summary":"Create a route","description":"","operationId":"postEmailDomainsDomainnameRoutes","produces":["application/json"],"parameters":[{"name":"domainName","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEmailDomainsDomainnameRoutes"}},"/api/v2/routing/email/domains/{domainName}/routes/{routeId}":{"get":{"tags":["Routing"],"summary":"Get a route","description":"","operationId":"getEmailDomainsDomainnameRoutesRouteId","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailDomainsDomainnameRoutesRouteId"},"put":{"tags":["Routing"],"summary":"Update a route","description":"","operationId":"putEmailDomainsDomainnameRoutesRouteId","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putEmailDomainsDomainnameRoutesRouteId"},"delete":{"tags":["Routing"],"summary":"Delete a route","description":"","operationId":"deleteEmailDomainsDomainnameRoutesRouteId","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteEmailDomainsDomainnameRoutesRouteId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailSetup"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required.field.missing":"A required field is missing a value."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQueues"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"A queue with that name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteQueuesQueueId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getQueuesQueueIdEstimatedwaittime"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchQueuesQueueIdUsers"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchQueuesQueueIdUsersMemberId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQueuesQueueIdWrapupcodes"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteQueuesQueueIdWrapupcodesCodeId"}},"/api/v2/routing/skills":{"get":{"tags":["Routing"],"summary":"Get the list of routing 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"}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSkills"},"post":{"tags":["Routing"],"summary":"Create Skill","description":"","operationId":"postSkills","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Skill","required":false,"schema":{"$ref":"#/definitions/RoutingSkill"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSkills"}},"/api/v2/routing/skills/{skillId}":{"get":{"tags":["Routing"],"summary":"Get Routing Skill","description":"","operationId":"getSkillsSkillId","produces":["application/json"],"parameters":[{"name":"skillId","in":"path","description":"Skill ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSkillsSkillId"},"delete":{"tags":["Routing"],"summary":"Delete Routing Skill","description":"","operationId":"deleteSkillsSkillId","produces":["application/json"],"parameters":[{"name":"skillId","in":"path","description":"Skill 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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSkillsSkillId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteUtilization"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postWrapupcodes"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteWrapupcodesCodeId"}},"/api/v2/search":{"get":{"tags":["Search","Suggest"],"summary":"Search using q64","description":"","operationId":"getSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","required":false,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"profile","in":"query","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSearch"},"post":{"tags":["Search","Suggest"],"summary":"Search","description":"","operationId":"postSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":false,"schema":{"$ref":"#/definitions/SearchRequest"}},{"name":"profile","in":"query","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSearch"}},"/api/v2/search/suggest":{"get":{"tags":["Search","Suggest"],"summary":"Suggest using q64","description":"","operationId":"getSuggest","produces":["application/json"],"parameters":[{"name":"q64","in":"query","required":false,"type":"string"},{"name":"profile","in":"query","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSuggest"},"post":{"tags":["Search","Suggest"],"summary":"Suggest","description":"","operationId":"postSuggest","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":false,"schema":{"$ref":"#/definitions/SuggestSearchRequest"}},{"name":"profile","in":"query","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSuggest"}},"/api/v2/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"},{"name":"lineAppearanceId","in":"query","description":"lineAppearanceId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getStations"}},"/api/v2/stations/{stationId}":{"get":{"tags":["Stations"],"summary":"Get station.","description":"","operationId":"getStationId","produces":["application/json"],"parameters":[{"name":"stationId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getStationId"}},"/api/v2/stations/{stationId}/associateduser":{"delete":{"tags":["Stations"],"summary":"Unassigns the user assigned to this station","description":"","operationId":"deleteStationIdAssociateduser","produces":["application/json"],"parameters":[{"name":"stationId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteStationIdAssociateduser"}},"/api/v2/systempresences":{"get":{"tags":["Presence"],"summary":"Get the list of SystemPresences","description":"","operationId":"getSystempresences","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSystempresences"}},"/api/v2/telephony/providers/edges":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of edges.","description":"","operationId":"getProvidersEdges","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdges"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a edge.","description":"","operationId":"postProvidersEdges","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdges"}},"/api/v2/telephony/providers/edges/addressvalidation":{"post":{"tags":["Telephony Providers Edge"],"summary":"Validates a street address","description":"","operationId":"postProvidersEdgesAddressvalidation","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesAddressvalidation"}},"/api/v2/telephony/providers/edges/availablelanguages":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of available languages.","description":"","operationId":"getProvidersEdgesAvailablelanguages","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableLanguageList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesAvailablelanguages"}},"/api/v2/telephony/providers/edges/certificateauthorities":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of certificate authorities.","description":"","operationId":"getProvidersEdgesCertificateauthorities","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesCertificateauthorities"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a certificate authority.","description":"","operationId":"postProvidersEdgesCertificateauthorities","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesCertificateauthorities"}},"/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a certificate authority.","description":"","operationId":"getProvidersEdgesCertificateauthoritiesCertificateId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesCertificateauthoritiesCertificateId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a certificate authority.","description":"","operationId":"putProvidersEdgesCertificateauthoritiesCertificateId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesCertificateauthoritiesCertificateId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a certificate authority.","description":"","operationId":"deleteProvidersEdgesCertificateauthoritiesCertificateId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesCertificateauthoritiesCertificateId"}},"/api/v2/telephony/providers/edges/didpools":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of DID Pools","description":"","operationId":"getProvidersEdgesDidpools","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesDidpools"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new DID pool","description":"","operationId":"postProvidersEdgesDidpools","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesDidpools"}},"/api/v2/telephony/providers/edges/didpools/{didPoolId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a DID Pool by ID.","description":"","operationId":"getProvidersEdgesDidpoolsDidpoolId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesDidpoolsDidpoolId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a DID Pool by ID.","description":"","operationId":"putProvidersEdgesDidpoolsDidpoolId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesDidpoolsDidpoolId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a DID Pool by ID.","description":"","operationId":"deleteProvidersEdgesDidpoolsDidpoolId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesDidpoolsDidpoolId"}},"/api/v2/telephony/providers/edges/dids":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of DIDs","description":"","operationId":"getProvidersEdgesDids","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesDids"}},"/api/v2/telephony/providers/edges/dids/{didId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a DID by ID.","description":"","operationId":"getProvidersEdgesDidsDidId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesDidsDidId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a DID by ID.","description":"","operationId":"putProvidersEdgesDidsDidId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesDidsDidId"}},"/api/v2/telephony/providers/edges/edgegroups":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of edge groups.","description":"","operationId":"getProvidersEdgesEdgegroups","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgegroups"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge group.","description":"","operationId":"postProvidersEdgesEdgegroups","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"An edge group with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required.field.missing":"A required field is missing a value."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesEdgegroups"}},"/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge group.","description":"","operationId":"getProvidersEdgesEdgegroupsEdgegroupId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgegroupsEdgegroupId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an edge group.","description":"","operationId":"putProvidersEdgesEdgegroupsEdgegroupId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"An edge group with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required.field.missing":"A required field is missing a value."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesEdgegroupsEdgegroupId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an edge group.","description":"","operationId":"deleteProvidersEdgesEdgegroupsEdgegroupId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesEdgegroupsEdgegroupId"}},"/api/v2/telephony/providers/edges/edgeversionreport":{"get":{"tags":["Telephony Providers Edge"],"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":"getProvidersEdgesEdgeversionreport","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeversionreport"}},"/api/v2/telephony/providers/edges/endpoints":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get endpoints","description":"","operationId":"getProvidersEdgesEndpoints","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEndpoints"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create endpoint","description":"","operationId":"postProvidersEdgesEndpoints","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesEndpoints"}},"/api/v2/telephony/providers/edges/endpoints/{endpointId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get endpoint","description":"","operationId":"getProvidersEdgesEndpointsEndpointId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEndpointsEndpointId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update endpoint","description":"","operationId":"putProvidersEdgesEndpointsEndpointId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesEndpointsEndpointId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete endpoint","description":"","operationId":"deleteProvidersEdgesEndpointsEndpointId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesEndpointsEndpointId"}},"/api/v2/telephony/providers/edges/extensionpools":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of extension pools","description":"","operationId":"getProvidersEdgesExtensionpools","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesExtensionpools"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new extension pool","description":"","operationId":"postProvidersEdgesExtensionpools","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesExtensionpools"}},"/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an extension pool by ID","description":"","operationId":"getProvidersEdgesExtensionpoolsExtensionpoolId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesExtensionpoolsExtensionpoolId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an extension pool by ID","description":"","operationId":"putProvidersEdgesExtensionpoolsExtensionpoolId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesExtensionpoolsExtensionpoolId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an extension pool by ID","description":"","operationId":"deleteProvidersEdgesExtensionpoolsExtensionpoolId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesExtensionpoolsExtensionpoolId"}},"/api/v2/telephony/providers/edges/extensions":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of extensions","description":"","operationId":"getProvidersEdgesExtensions","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesExtensions"}},"/api/v2/telephony/providers/edges/extensions/{extensionId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an extension by ID.","description":"","operationId":"getProvidersEdgesExtensionsExtensionId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesExtensionsExtensionId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an extension by ID.","description":"","operationId":"putProvidersEdgesExtensionsExtensionId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesExtensionsExtensionId"}},"/api/v2/telephony/providers/edges/linebasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of line base settings objects","description":"","operationId":"getProvidersEdgesLinebasesettings","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesLinebasesettings"}},"/api/v2/telephony/providers/edges/linebasesettings/{lineBaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a line base settings object by ID","description":"","operationId":"getProvidersEdgesLinebasesettingsLinebaseId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesLinebasesettingsLinebaseId"}},"/api/v2/telephony/providers/edges/lines":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Lines","description":"","operationId":"getProvidersEdgesLines","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesLines"}},"/api/v2/telephony/providers/edges/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":"getProvidersEdgesLinesTemplate","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesLinesTemplate"}},"/api/v2/telephony/providers/edges/lines/{lineId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Line by ID","description":"","operationId":"getProvidersEdgesLinesLineId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesLinesLineId"}},"/api/v2/telephony/providers/edges/outboundroutes":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get outbound routes","description":"","operationId":"getProvidersEdgesOutboundroutes","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesOutboundroutes"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create outbound rule","description":"","operationId":"postProvidersEdgesOutboundroutes","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"An outbound route with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required.field.missing":"A required field is missing a value."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesOutboundroutes"}},"/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get outbound route","description":"","operationId":"getProvidersEdgesOutboundroutesOutboundrouteId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesOutboundroutesOutboundrouteId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update outbound route","description":"","operationId":"putProvidersEdgesOutboundroutesOutboundrouteId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"An outbound route with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required.field.missing":"A required field is missing a value."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesOutboundroutesOutboundrouteId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete Outbound Route","description":"","operationId":"deleteProvidersEdgesOutboundroutesOutboundrouteId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesOutboundroutesOutboundrouteId"}},"/api/v2/telephony/providers/edges/phonebasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Phone Base Settings objects","description":"","operationId":"getProvidersEdgesPhonebasesettings","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesPhonebasesettings"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new Phone Base Settings object","description":"","operationId":"postProvidersEdgesPhonebasesettings","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesPhonebasesettings"}},"/api/v2/telephony/providers/edges/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":"getProvidersEdgesPhonebasesettingsAvailablemetabases","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesPhonebasesettingsAvailablemetabases"}},"/api/v2/telephony/providers/edges/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":"getProvidersEdgesPhonebasesettingsTemplate","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesPhonebasesettingsTemplate"}},"/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone Base Settings object by ID","description":"","operationId":"getProvidersEdgesPhonebasesettingsPhonebaseId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesPhonebasesettingsPhonebaseId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Phone Base Settings by ID","description":"","operationId":"putProvidersEdgesPhonebasesettingsPhonebaseId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesPhonebasesettingsPhonebaseId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Phone Base Settings by ID","description":"","operationId":"deleteProvidersEdgesPhonebasesettingsPhonebaseId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesPhonebasesettingsPhonebaseId"}},"/api/v2/telephony/providers/edges/phones":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Phone Instances","description":"","operationId":"getProvidersEdgesPhones","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":"webRtcUser.id","in":"query","description":"Filter by webRtcUser.id","required":false,"type":"string"},{"name":"phoneBaseSettings.id","in":"query","description":"Filter by phoneBaseSettings.id","required":false,"type":"string"},{"name":"lines.loggedInUser.id","in":"query","description":"Filter by lines.loggedInUser.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","status","status.primaryEdgesStatus","status.secondaryEdgesStatus","phoneBaseSettings","lines"]},"collectionFormat":"multi"},{"name":"fields","in":"query","description":"Fields and properties to get, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["webRtcUser","properties.*","lines.loggedInUser"]},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesPhones"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new Phone","description":"","operationId":"postProvidersEdgesPhones","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesPhones"}},"/api/v2/telephony/providers/edges/phones/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot Multiple Phones","description":"","operationId":"postProvidersEdgesPhonesReboot","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.phone.no.active.edge":"Phone is not connected to an active edge and cannot be rebooted.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesPhonesReboot"}},"/api/v2/telephony/providers/edges/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":"getProvidersEdgesPhonesTemplate","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesPhonesTemplate"}},"/api/v2/telephony/providers/edges/phones/{phoneId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone by ID","description":"","operationId":"getProvidersEdgesPhonesPhoneId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesPhonesPhoneId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Phone by ID","description":"","operationId":"putProvidersEdgesPhonesPhoneId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesPhonesPhoneId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Phone by ID","description":"","operationId":"deleteProvidersEdgesPhonesPhoneId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesPhonesPhoneId"}},"/api/v2/telephony/providers/edges/phones/{phoneId}/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot a Phone","description":"","operationId":"postProvidersEdgesPhonesPhoneIdReboot","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.phone.no.active.edge":"Phone is not connected to an active edge and cannot be rebooted.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesPhonesPhoneIdReboot"}},"/api/v2/telephony/providers/edges/sites":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of Sites.","description":"","operationId":"getProvidersEdgesSites","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesSites"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a Site.","description":"","operationId":"postProvidersEdgesSites","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesSites"}},"/api/v2/telephony/providers/edges/sites/{siteId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Site by ID.","description":"","operationId":"getProvidersEdgesSitesSiteId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesSitesSiteId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Site by ID.","description":"","operationId":"putProvidersEdgesSitesSiteId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesSitesSiteId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Site by ID","description":"","operationId":"deleteProvidersEdgesSitesSiteId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesSitesSiteId"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of Number Plans for this Site.","description":"","operationId":"getProvidersEdgesSitesSiteIdNumberplans","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesSitesSiteIdNumberplans"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update the list of Number Plans.","description":"","operationId":"putProvidersEdgesSitesSiteIdNumberplans","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","error.updating.number.plans":"There was a problem updating number plans.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesSitesSiteIdNumberplans"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Classifications for this Site","description":"","operationId":"getProvidersEdgesSitesSiteIdNumberplansClassifications","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesSitesSiteIdNumberplansClassifications"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Number Plan by ID.","description":"","operationId":"getProvidersEdgesSitesSiteIdNumberplansNumberplanId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesSitesSiteIdNumberplansNumberplanId"}},"/api/v2/telephony/providers/edges/sites/{siteId}/rebalance":{"post":{"tags":["Telephony Providers Edge"],"summary":"Triggers the rebalance operation.","description":"","operationId":"postProvidersEdgesSitesSiteIdRebalance","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesSitesSiteIdRebalance"}},"/api/v2/telephony/providers/edges/timezones":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Edge-compatible time zones","description":"","operationId":"getProvidersEdgesTimezones","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesTimezones"}},"/api/v2/telephony/providers/edges/trunkbasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get Trunk Base Settings listing","description":"","operationId":"getProvidersEdgesTrunkbasesettings","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":"recordingEnabled","in":"query","description":"Filter trunks by recording enabled","required":false,"type":"boolean"}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesTrunkbasesettings"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a Trunk Base Settings object","description":"","operationId":"postProvidersEdgesTrunkbasesettings","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"A trunk with that name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required.field.missing":"A required field is missing a value."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesTrunkbasesettings"}},"/api/v2/telephony/providers/edges/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":"getProvidersEdgesTrunkbasesettingsAvailablemetabases","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesTrunkbasesettingsAvailablemetabases"}},"/api/v2/telephony/providers/edges/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":"getProvidersEdgesTrunkbasesettingsTemplate","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesTrunkbasesettingsTemplate"}},"/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk Base Settings object by ID","description":"","operationId":"getProvidersEdgesTrunkbasesettingsTrunkbasesettingsId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesTrunkbasesettingsTrunkbasesettingsId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Trunk Base Settings object by ID","description":"","operationId":"putProvidersEdgesTrunkbasesettingsTrunkbasesettingsId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"A trunk with that name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required.field.missing":"A required field is missing a value."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesTrunkbasesettingsTrunkbasesettingsId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Trunk Base Settings object by ID","description":"","operationId":"deleteProvidersEdgesTrunkbasesettingsTrunkbasesettingsId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","delete.referenced.entity":"The trunk is being referenced.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesTrunkbasesettingsTrunkbasesettingsId"}},"/api/v2/telephony/providers/edges/trunks":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of available trunks.","description":"Trunks are created by assigning trunk base settings to an Edge or Edge Group.","operationId":"getProvidersEdgesTrunks","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":"edge.id","in":"query","description":"Filter by Edge Ids","required":false,"type":"string"},{"name":"trunkBase.id","in":"query","description":"Filter by Trunk Base Ids","required":false,"type":"string"},{"name":"trunkType","in":"query","description":"Filter by a Trunk type","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesTrunks"}},"/api/v2/telephony/providers/edges/trunks/{trunkId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk by ID","description":"","operationId":"getProvidersEdgesTrunksTrunkId","produces":["application/json"],"parameters":[{"name":"trunkId","in":"path","description":"Trunk ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trunk"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesTrunksTrunkId"}},"/api/v2/telephony/providers/edges/trunkswithrecording":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get Counts of trunks that have recording disabled or enabled","description":"","operationId":"getProvidersEdgesTrunkswithrecording","produces":["application/json"],"parameters":[{"name":"trunkType","in":"query","description":"The type of this trunk base.","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkRecordingEnabledCount"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesTrunkswithrecording"}},"/api/v2/telephony/providers/edges/{edgeId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge.","description":"","operationId":"getProvidersEdgesEdgeId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a edge.","description":"","operationId":"putProvidersEdgesEdgeId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","edge.group.required":"The edge group field is missing a value.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","site.required":"The site field is missing a value."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesEdgeId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a edge.","description":"","operationId":"deleteProvidersEdgesEdgeId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesEdgeId"}},"/api/v2/telephony/providers/edges/{edgeId}/lines":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of lines.","description":"","operationId":"getProvidersEdgesEdgeIdLines","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeIdLines"}},"/api/v2/telephony/providers/edges/{edgeId}/lines/{lineId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get line","description":"","operationId":"getProvidersEdgesEdgeIdLinesLineId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeIdLinesLineId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a line.","description":"","operationId":"putProvidersEdgesEdgeIdLinesLineId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesEdgeIdLinesLineId"}},"/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge logical interfaces.","description":"Retrieve a list of all configured logical interfaces from a specific edge.","operationId":"getProvidersEdgesEdgeIdLogicalinterfaces","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeIdLogicalinterfaces"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge logical interface.","description":"Create","operationId":"postProvidersEdgesEdgeIdLogicalinterfaces","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"A logical interface with that vlanTagId already exists on this port.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesEdgeIdLogicalinterfaces"}},"/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an edge logical interface","description":"","operationId":"getProvidersEdgesEdgeIdLogicalinterfacesInterfaceId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeIdLogicalinterfacesInterfaceId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an edge logical interface.","description":"","operationId":"putProvidersEdgesEdgeIdLogicalinterfacesInterfaceId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"A logical interface with that vlanTagId already exists on this port.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesEdgeIdLogicalinterfacesInterfaceId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an edge logical interface","description":"","operationId":"deleteProvidersEdgesEdgeIdLogicalinterfacesInterfaceId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesEdgeIdLogicalinterfacesInterfaceId"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs":{"post":{"tags":["Telephony Providers Edge"],"summary":"Create a job to upload a list of Edge logs.","description":"","operationId":"postProvidersEdgesEdgeIdLogsJobs","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesEdgeIdLogsJobs"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an Edge logs job.","description":"","operationId":"getProvidersEdgesEdgeIdLogsJobsJobId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeIdLogsJobsJobId"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload":{"post":{"tags":["Telephony Providers Edge"],"summary":"Request that the specified fileIds be uploaded from the Edge.","description":"","operationId":"postProvidersEdgesEdgeIdLogsJobsJobIdUpload","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesEdgeIdLogsJobsJobIdUpload"}},"/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Retrieve a list of all configured physical interfaces from a specific edge.","description":"","operationId":"getProvidersEdgesEdgeIdPhysicalinterfaces","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeIdPhysicalinterfaces"}},"/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge physical interface.","description":"Retrieve a physical interface from a specific edge.","operationId":"getProvidersEdgesEdgeIdPhysicalinterfacesInterfaceId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeIdPhysicalinterfacesInterfaceId"}},"/api/v2/telephony/providers/edges/{edgeId}/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot an Edge","description":"","operationId":"postProvidersEdgesEdgeIdReboot","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesEdgeIdReboot"}},"/api/v2/telephony/providers/edges/{edgeId}/softwareupdate":{"get":{"tags":["Telephony Providers Edge"],"summary":"Gets software update status information about any edge.","description":"","operationId":"getProvidersEdgesEdgeIdSoftwareupdate","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeIdSoftwareupdate"},"post":{"tags":["Telephony Providers Edge"],"summary":"Starts a software update for this edge.","description":"","operationId":"postProvidersEdgesEdgeIdSoftwareupdate","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesEdgeIdSoftwareupdate"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Cancels any in-progress update for this edge.","description":"","operationId":"deleteProvidersEdgesEdgeIdSoftwareupdate","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesEdgeIdSoftwareupdate"}},"/api/v2/telephony/providers/edges/{edgeId}/softwareversions":{"get":{"tags":["Telephony Providers Edge"],"summary":"Gets all the available software versions for this edge.","description":"","operationId":"getProvidersEdgesEdgeIdSoftwareversions","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeIdSoftwareversions"}},"/api/v2/telephony/providers/edges/{edgeId}/unpair":{"post":{"tags":["Telephony Providers Edge"],"summary":"Unpair an Edge","description":"","operationId":"postProvidersEdgesEdgeIdUnpair","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesEdgeIdUnpair"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getTimezones"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteMe"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserrecordings"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSummary"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteRecordingId"}},"/api/v2/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 media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","NONE"]}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRecordingIdMedia"}},"/api/v2/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":"The list of user ids to get. Paging is ignored if ids are specified","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization"]},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUsers"},"post":{"tags":["Users"],"summary":"Create user","description":"","operationId":"postUsers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"User","required":false,"schema":{"$ref":"#/definitions/CreateUser"}}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postUsers"}},"/api/v2/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","presence","conversationSummary","outOfOffice","geolocation","station","authorization","date","geolocationsettings","organization","presencedefinitions","locations"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserMe"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMe"}},"/api/v2/users/search":{"get":{"tags":["Search","Users"],"summary":"Search using q64","description":"","operationId":"getSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","required":false,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSearch"},"post":{"tags":["Search","Users"],"summary":"Search","description":"","operationId":"postSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":false,"schema":{"$ref":"#/definitions/UserSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSearch"}},"/api/v2/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","presence","conversationSummary","outOfOffice","geolocation","station","authorization"]},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserId"},"delete":{"tags":["Users"],"summary":"Delete user","description":"","operationId":"deleteUserId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User 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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteUserId"},"patch":{"tags":["Users"],"summary":"Update user","description":"","operationId":"patchUserId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserIdCallforwarding"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserIdGeolocationsClientId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postUserIdGreetings"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdGreetingsDefaults"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdOutofoffice"}},"/api/v2/users/{userId}/presences/{sourceId}":{"get":{"tags":["Presence"],"summary":"Get a user's Presence","description":"","operationId":"getUserIdPresencesSourceId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"sourceId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdPresencesSourceId"},"patch":{"tags":["Presence"],"summary":"Patch a user's Presence","description":"The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.","operationId":"patchUserIdPresencesSourceId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Source","required":true,"type":"string"},{"in":"body","name":"body","required":false,"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserIdPresencesSourceId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserIdQueues"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserIdQueuesQueueId"}},"/api/v2/users/{userId}/roles":{"get":{"tags":["Authorization","Users"],"summary":"Returns a listing of roles and permissions for a 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":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdRoles"},"put":{"tags":["Authorization","Users"],"summary":"Sets the user's roles","description":"","operationId":"putUserIdRoles","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":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdRoles"},"delete":{"tags":["Authorization","Users"],"summary":"Removes all the roles from the user.","description":"","operationId":"deleteUserIdRoles","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteUserIdRoles"}},"/api/v2/users/{userId}/routingskills":{"get":{"tags":["Routing","Users"],"summary":"List routing skills for user","description":"","operationId":"getUserIdRoutingskills","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"},{"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/UserSkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdRoutingskills"},"post":{"tags":["Routing","Users"],"summary":"Add routing skill to user","description":"","operationId":"postUserIdRoutingskills","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Skill","required":false,"schema":{"$ref":"#/definitions/UserRoutingSkill"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postUserIdRoutingskills"}},"/api/v2/users/{userId}/routingskills/{skillId}":{"put":{"tags":["Routing","Users"],"summary":"Update routing skill proficiency or state.","description":"","operationId":"putUserIdRoutingskillsSkillId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"skillId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","description":"Skill","required":false,"schema":{"$ref":"#/definitions/UserRoutingSkill"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdRoutingskillsSkillId"},"delete":{"tags":["Routing","Users"],"summary":"Remove routing skill from user","description":"","operationId":"deleteUserIdRoutingskillsSkillId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"skillId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteUserIdRoutingskillsSkillId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"An invalid routing status transition was attempted.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdRoutingstatus"}},"/api/v2/users/{userId}/station":{"get":{"tags":["Users"],"summary":"Get station information for user","description":"","operationId":"getUserIdStation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserStations"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdStation"}},"/api/v2/users/{userId}/station/associatedstation":{"delete":{"tags":["Users"],"summary":"Clear associated station","description":"","operationId":"deleteUserIdStationAssociatedstation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteUserIdStationAssociatedstation"}},"/api/v2/users/{userId}/station/associatedstation/{stationId}":{"put":{"tags":["Users"],"summary":"Set associated station","description":"","operationId":"putUserIdStationAssociatedstationStationId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"stationId","in":"path","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdStationAssociatedstationStationId"}},"/api/v2/users/{userId}/station/defaultstation":{"delete":{"tags":["Users"],"summary":"Clear default station","description":"","operationId":"deleteUserIdStationDefaultstation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteUserIdStationDefaultstation"}},"/api/v2/users/{userId}/station/defaultstation/{stationId}":{"put":{"tags":["Users"],"summary":"Set default station","description":"","operationId":"putUserIdStationDefaultstationStationId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"stationId","in":"path","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdStationDefaultstationStationId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMailbox"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteMessages"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteMessagesMessageId"}},"/api/v2/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 media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","NONE"]}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMessagesMessageIdMedia"}},"/api/v2/voicemail/policy":{"get":{"tags":["Voicemail"],"summary":"Get a policy","description":"","operationId":"getPolicy","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPolicy"},"put":{"tags":["Voicemail"],"summary":"Update a policy","description":"","operationId":"putPolicy","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putPolicy"}},"/api/v2/voicemail/userpolicies/{userId}":{"get":{"tags":["Voicemail"],"summary":"Get a user's voicemail policy","description":"","operationId":"getUserpoliciesUserId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserpoliciesUserId"},"patch":{"tags":["Voicemail"],"summary":"Update a user's voicemail policy","description":"","operationId":"patchUserpoliciesUserId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserpoliciesUserId"}}},"securityDefinitions":{"PureCloud Auth":{"type":"oauth2","authorizationUrl":"https://auth.us-east-1.mypurecloud.com/authorize","flow":"implicit","scopes":{"all":"All the scopes"}}},"definitions":{"DocusignTemplateMapping":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"docusignTemplateId":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserAuthorization":{"type":"object","properties":{"roles":{"type":"array","items":{"$ref":"#/definitions/DomainRole"}},"permissions":{"type":"array","description":"A collection of the permissions granted by all assigned roles","readOnly":true,"items":{"type":"string"}},"permissionPolicies":{"type":"array","description":"The policies configured for assigned permissions.","readOnly":true,"items":{"$ref":"#/definitions/ResourcePermissionPolicy"}}}},"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/SharedEntity"},"memberType":{"type":"string","enum":["USER","PUBLIC"]},"member":{"$ref":"#/definitions/SharedEntity"},"members":{"type":"array","items":{"$ref":"#/definitions/CreateShareRequestMember"}}}},"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"}}},"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"}}}},"AggregationResultEntry":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"value":{"type":"string","description":"For termFrequency aggregations"},"gte":{"type":"number","description":"For numericRange aggregations"},"lt":{"type":"number","description":"For numericRange aggregations"}}},"DomainOrganizationProduct":{"type":"object","properties":{"id":{"type":"string"}}},"EmailConversationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/EmailConversation"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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","required":["rules"],"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 time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"contactList":{"description":"The identifier of an example contact list that provides user-interface suggestions for contact-based conditions and actions","$ref":"#/definitions/UriReference"},"queue":{"description":"The identifier of an example queue that provides user-interface suggestions for wrap-up associated conditions","$ref":"#/definitions/UriReference"},"rules":{"type":"array","description":"The list of rules","items":{"$ref":"#/definitions/DialerRule"}},"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"}}},"SceneEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Scene"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"BillingContact":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"ivrCode":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ADFS":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"disabled":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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","inactive","deleted"]},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmailConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/EmailMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"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}}},"TimeZone":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"offset":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmailMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected on 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 this participant when disconnected on the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"purpose":{"type":"string","description":"The participant's purpose.  Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state.  Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","CONVERTING","UPLOADING","TRANSMITTING","NONE"]},"direction":{"type":"string","description":"The participant's direction.  Values can be: 'inbound' or 'outbound'","enum":["INBOUND","OUTBOUND"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold.","default":false},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up.","default":false},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/UriReference"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/UriReference"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorBody"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/UriReference"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up.","default":false},"subject":{"type":"string","description":"The subject of the email."},"messagesSent":{"type":"integer","format":"int32","description":"The number of messages that have been sent in this email conversation."}}},"ArchitectAuditMessage":{"type":"object","properties":{"action":{"type":"string","description":"The audit action","enum":["CHECKIN","PUBLISH","DELETE"]},"user":{"$ref":"#/definitions/AuditUser"},"timestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"changes":{"type":"array","items":{"$ref":"#/definitions/Change"}},"entity":{"$ref":"#/definitions/AuditEntity"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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}}},"RoutingSkill":{"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 last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"state":{"type":"string","description":"The current state for this skill.","readOnly":true,"enum":["active","inactive","deleted"]},"version":{"type":"string","description":"Required when updating. Version must be the current version. Only the system can assign version.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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}}},"CallbackIdentifier":{"type":"object","required":["id","type"],"properties":{"type":{"type":"string","description":"The type of the associated callback participant","enum":["ACD","EXTERNAL"]},"id":{"type":"string","description":"The identifier of the callback"}}},"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}}},"AccountManager":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PolicyActions":{"type":"object","properties":{"retainRecording":{"type":"boolean","description":"true to retain the recording associated with the conversation. Default = true","default":false},"deleteRecording":{"type":"boolean","description":"true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false","default":false},"alwaysDelete":{"type":"boolean","description":"true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false","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"},"initiateScreenRecording":{"$ref":"#/definitions/InitiateScreenRecording"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","required":["addresses"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"addresses":{"type":"array","description":"A list of outbound fax dialing addresses. E.g. [phone] or 3175555555","items":{"type":"string"}},"documentId":{"type":"string","description":"DocumentId of Content Management artifact. If Content Management document is not used for faxing, documentId should be null"},"contentType":{"type":"string","description":"The content type that is going to be uploaded. If Content Management document is used for faxing, contentType will be ignored","enum":["application/pdf","image/tiff","application/msword","application/vnd.oasis.opendocument.text","application/vnd.openxmlformats-officedocument.wordprocessingml.document"]},"workspace":{"description":"Workspace in which the document should be stored. If Content Management document is used for faxing, workspace will be ignored","$ref":"#/definitions/Workspace"},"coverSheet":{"description":"Data for coversheet generation.","$ref":"#/definitions/CoverSheet"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmbeddedSignatureView":{"type":"object","properties":{"view":{"$ref":"#/definitions/View"},"envelopeId":{"type":"string","description":"Envelope id for the terms and conditions associated with this request."}}},"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}}},"AggregationQuery":{"type":"object","properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","format":"date-time","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["conversationId","sessionId","mediaType","queueId","userId","participantId","participantName","direction","wrapUpCode","wrapUpNote","interactionType","requestedRoutingSkillId","requestedLanguageId","purpose","participantType","segmentType","disconnectType","errorCode","stationId","edgeId","dnis","ani","outboundCampaignId","outboundContactId","outboundContactListId","monitoredParticipantId","sourceSessionId","destinationSessionId","sourceConversationId","destinationConversationId","remoteNameDisplayable","sipResponseCode","q850ResponseCode","conference","groupId","roomId","addressFrom","addressTo","evaluationId","evaluatorId","contextId","formId","formName","eventTime"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/AnalyticsQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *).","items":{"type":"string","enum":["tSegmentDuration","oTotalCriticalScore","oTotalScore","nEvaluations","tAbandon","tIvr","tAnswered","tAcd","tTalk","tHeld","tTalkComplete","tHeldComplete","tAcw","tHandle","tWait","tAgentRoutingStatus","tOrganizationPresence","tSystemPresence","tUserResponseTime","tAgentResponseTime","nOffered","nOverSla","nTransferred","nOutboundAttempted","nOutboundConnected","nOutboundAbandoned","nError","oServiceTarget","oServiceLevel","tActive","tInactive","oActiveUsers","oMemberUsers","oActiveQueues","oMemberQueues","oInteracting","oWaiting"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')","default":false}}},"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","GROUP"]},"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":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"defaultSet":{"type":"array","description":"The default set of wrapup values","uniqueItems":true,"items":{"type":"string","enum":["CONTACT_UNCALLABLE","NUMBER_UNCALLABLE","RIGHT_PARTY_CONTACT"]}},"mapping":{"type":"object","description":"A map from wrapup code identifiers to a set of wrapup values","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/AuditUser"},"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/AuditEntity"},"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","inactive","deleted"]},"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}}},"BillingTaskResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"taskType":{"type":"string","enum":["GENERATE_PCV_USAGE_REPORT","GENERATE_BILLABLE_USAGE_REPORT","GENERATE_CONCURRENT_USAGE_REPORT","CREATE_QUOTE","CREATE_SALESFORCE_ACCOUNT","SUBMIT_QUOTE","GENERATE_CONTRACT","OTHER"]},"status":{"type":"string","enum":["IN_PROGRESS","SUCCEEDED","FAILED"]},"resultId":{"type":"string"},"resultUri":{"type":"string"},"resultDownloadUrl":{"type":"string"},"errorCode":{"type":"string"},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"UserStations":{"type":"object","properties":{"associatedStation":{"description":"Current associated station for this user.","readOnly":true,"$ref":"#/definitions/UserStation"},"effectiveStation":{"description":"The station where the user can be reached based on their default and associated station.","readOnly":true,"$ref":"#/definitions/UserStation"},"defaultStation":{"description":"Default station to be used if not associated with a station.","readOnly":true,"$ref":"#/definitions/UserStation"},"lastAssociatedStation":{"description":"Last associated station for this user.","readOnly":true,"$ref":"#/definitions/UserStation"}}},"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":{"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"}}},"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"]}}},"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}}},"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","inactive","deleted"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"mediaSettings":{"type":"object","additionalProperties":{"$ref":"#/definitions/MediaSetting"}},"bullseye":{"$ref":"#/definitions/Bullseye"},"acwSettings":{"$ref":"#/definitions/AcwSettings"},"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"},"entity":{"$ref":"#/definitions/AuditEntity"},"level":{"type":"string"},"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}}},"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":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"startDayOfWeek":{"type":"string"},"timezone":{"type":"string"},"version":{"type":"integer","format":"int32"},"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","inactive","deleted"]},"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}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"ExportUri":{"type":"object","properties":{"uri":{"type":"string"},"exportTimestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactSort":{"type":"object","properties":{"fieldName":{"type":"string"},"direction":{"type":"string","enum":["ASC","DESC"]},"numeric":{"type":"boolean","default":false}}},"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}}},"AuditFilter":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"operator":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"SearchCriteria":{"type":"object","properties":{"endValue":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"startValue":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}},"value":{"type":"string"},"operator":{"type":"string","enum":["AND","OR","NOT"]},"group":{"type":"array","items":{"$ref":"#/definitions/SearchCriteria"}},"type":{"type":"string","enum":["EXACT","CONTAINS","STARTS_WITH","REQUIRED_FIELDS","RANGE","DATE_RANGE","LESS_THAN","LESS_THAN_EQUAL_TO","GREATER_THAN","GREATER_THAN_EQUAL_TO","SIMPLE","TERM","TERMS","QUERY_STRING"]}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ConversationChat":{"type":"object","properties":{"state":{"type":"string","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","NONE"]},"id":{"type":"string"},"roomId":{"type":"string"},"recordingId":{"type":"string"},"segments":{"type":"array","items":{"$ref":"#/definitions/Segment"}},"held":{"type":"boolean","default":false},"direction":{"type":"string","enum":["INBOUND","OUTBOUND"]},"disconnectType":{"type":"string","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","TRANSFER_FORWARD","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"},"disconnectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"DialerAction":{"type":"object","required":["actionTypeName","type"],"properties":{"type":{"type":"string","description":"Type of the action","enum":["Action","modifyContactAttribute"]},"actionTypeName":{"type":"string","description":"Identifier of the action","enum":["DO_NOT_DIAL","MODIFY_CONTACT_ATTRIBUTE","SWITCH_TO_PREVIEW","APPEND_NUMBER_TO_DNC_LIST","SCHEDULE_CALLBACK"]},"updateOption":{"type":"string","description":"Indicator of the type of update action (applicable only to certain types of actions)","enum":["SET","INCREMENT","DECREMENT","CURRENT_TIME"]},"properties":{"type":"object","description":"Map of key-value pairs pertinent to the action (different actions require different properties)","additionalProperties":{"type":"string"}}}},"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}}},"ResponseFilter":{"type":"object","required":["name","operator","values"],"properties":{"name":{"type":"string","description":"Field to filter on. Allowed values are 'name' and 'libraryId."},"operator":{"type":"string","description":"Filter operation: IN, EQUALS, NOTEQUALS.","enum":["IN","EQUALS","NOTEQUALS"]},"values":{"type":"array","description":"Values to filter on.","items":{"type":"string"}}},"description":"Used to filter response queries"},"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}}},"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."},"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":{"readOnly":true,"$ref":"#/definitions/Organization"},"user":{"readOnly":true,"$ref":"#/definitions/User"},"returnUrl":{"type":"string"},"template":{"description":"Template ID alias for the ESignature template you would like to retrieve.","$ref":"#/definitions/DocusignTemplateMapping"}}},"CampaignSequence":{"type":"object","required":["campaigns","currentCampaign","status"],"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 time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"campaigns":{"type":"array","description":"the ordered list of campaign identifiers","items":{"$ref":"#/definitions/UriReference"}},"currentCampaign":{"type":"integer","format":"int32","description":"the zero-based index of the current campaign in the campaigns list","readOnly":true},"status":{"type":"string","description":"status of the sequence","enum":["ON","OFF","COMPLETE"]},"stopMessage":{"type":"string","description":"if a sequence has unexpectedly stopped, this message provides the reason","readOnly":true},"repeat":{"type":"boolean","description":"indicates if a sequence is to repeat from the beginning after the last campaign completes; default is false","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeVersionReport":{"type":"object","properties":{"oldestVersion":{"$ref":"#/definitions/EdgeVersionInformation"},"newestVersion":{"$ref":"#/definitions/EdgeVersionInformation"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ExpansionCriterium":{"type":"object","properties":{"type":{"type":"string","enum":["TIMEOUT_SECONDS"]},"threshold":{"type":"number","format":"double"}}},"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","TRANSFER_FORWARD","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"},"disconnectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"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/BillingAddress"},"forRelatedPart":{"type":"string","description":"The part number of a part related to the quote charge."}}},"CampaignSchedule":{"type":"object","required":["campaign","intervals","timeZone"],"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 time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"intervals":{"type":"array","description":"a list of start and end times","items":{"$ref":"#/definitions/ScheduleInterval"}},"timeZone":{"type":"string","example":"Africa/Abidjan","description":"time zone identifier to be applied to the intervals; for example Africa/Abidjan"},"campaign":{"description":"identifier of the campaign to be scheduled","$ref":"#/definitions/UriReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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},"languageDefault":{"type":"boolean","default":false},"tags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"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","inactive","deleted"]},"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}}},"ComposerTemplate":{"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}}},"AnalyticsQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["conversationId","sessionId","mediaType","queueId","userId","participantId","participantName","direction","wrapUpCode","wrapUpNote","interactionType","requestedRoutingSkillId","requestedLanguageId","purpose","participantType","segmentType","disconnectType","errorCode","stationId","edgeId","dnis","ani","outboundCampaignId","outboundContactId","outboundContactListId","monitoredParticipantId","sourceSessionId","destinationSessionId","sourceConversationId","destinationConversationId","remoteNameDisplayable","sipResponseCode","q850ResponseCode","conference","groupId","roomId","addressFrom","addressTo","evaluationId","evaluatorId","contextId","formId","formName","eventTime"]},"propertyType":{"type":"string","description":"Left hand side for property predicates","enum":["bool","integer","real","date","string","uuid"]},"property":{"type":"string","description":"Left hand side for property predicates"},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["tSegmentDuration","oTotalCriticalScore","oTotalScore","nEvaluations","tAbandon","tIvr","tAnswered","tAcd","tTalk","tHeld","tTalkComplete","tHeldComplete","tAcw","tHandle","tWait","tAgentRoutingStatus","tOrganizationPresence","tSystemPresence","tUserResponseTime","tAgentResponseTime","nOffered","nOverSla","nTransferred","nOutboundAttempted","nOutboundConnected","nOutboundAbandoned","nError","oServiceTarget","oServiceLevel","tActive","tInactive","oActiveUsers","oMemberUsers","oActiveQueues","oMemberQueues","oInteracting","oWaiting"]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension, property, or metric predicates"},"range":{"description":"Right hand side for property or metric predicates","$ref":"#/definitions/NumericRange"}}},"SortField":{"type":"object","properties":{"name":{"type":"string"},"sortType":{"type":"string","enum":["ASCENDING","DESCENDING"]}}},"DiagnosticEmail":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"subject":{"type":"string","description":"Subject of Issue Report"},"topic":{"type":"string","description":"Functional Area of Issue","enum":["Admin","Documents","Chat","Video Chat","Login","Slowness","Other"]},"description":{"type":"string","description":"Detailed Description of Issue"},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH","CRITICAL"]},"type":{"type":"string","description":"Type of Issue","enum":["Problem","Question","Enhancement Request"]},"data":{"type":"object","description":"Json blob of data to be included with this report."}}},"OAuthProvider":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean","default":false},"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"}}},"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/ComposerTemplate"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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}}},"TransferRequest":{"type":"object","properties":{"userId":{"type":"string","description":"The user ID of the transfer target."},"address":{"type":"string","description":"The phone number or address of the transfer target."},"userName":{"type":"string","description":"The user name of the transfer target."},"queueId":{"type":"string","description":"The queue ID of the transfer target."},"voicemail":{"type":"boolean","description":"If true, then transfer to the user's voicemail.","default":false}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LocationSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string"},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"returnFields":{"type":"array","items":{"type":"string"}},"expand":{"type":"array","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/LocationSearchCriteria"}}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AnalyticsQueryClause":{"type":"object","properties":{"type":{"type":"string","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value). These can be one of three types: dimension, property, metric.","items":{"$ref":"#/definitions/AnalyticsQueryPredicate"}}}},"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"},"ChatMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"},"duration":{"$ref":"#/definitions/DurationCondition"}}},"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/UserRoutingSkill"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DialerContact":{"type":"object","required":["contactListId"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"contactListId":{"type":"string","description":"Identifier of the contact list containing this contact"},"data":{"type":"object","description":"A map of the contact's data attributes and values","additionalProperties":{"type":"object"}},"callRecords":{"type":"object","description":"A map of call records for the contact phone columns","readOnly":true,"additionalProperties":{"$ref":"#/definitions/CallRecord"}},"callable":{"type":"boolean","description":"false if the contact is not to be called","default":false},"phoneNumberStatus":{"type":"object","description":"A map of statuses for the contact phone columns","additionalProperties":{"$ref":"#/definitions/PhoneNumberStatus"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AnalyticsConversationQueryResponse":{"type":"object","properties":{"conversations":{"type":"array","items":{"$ref":"#/definitions/AnalyticsConversation"}},"aggregations":{"type":"array","items":{"$ref":"#/definitions/AggregationResult"}}}},"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 this organization."},"adminUsername":{"type":"string","description":"Administrator username for this organization in the form of an email address."},"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 this 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/BillingAddress"},"currency":{"type":"string","description":"The account currency."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Scene":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"sceneGroup":{"$ref":"#/definitions/SceneGroup"},"assets":{"type":"array","items":{"$ref":"#/definitions/Asset"}},"thumbnail":{"$ref":"#/definitions/Thumbnail"},"description":{"type":"string"},"waypoints":{"type":"array","items":{"$ref":"#/definitions/Waypoint"}},"defaultOrientationY":{"type":"number","format":"double"},"type":{"type":"string","enum":["PRIMARY","SECONDARY"]},"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"]}}},"VideoConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/VideoMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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."},"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"}}},"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","TRANSFER_FORWARD","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"},"disconnectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"SupportCreditListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/SupportCredit"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MediaSetting":{"type":"object","properties":{"alertingTimeoutSeconds":{"type":"integer","format":"int32"},"serviceLevel":{"$ref":"#/definitions/ServiceLevel"}}},"ChatConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/ChatMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","required":["types"],"properties":{"sortOrder":{"type":"string","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string"},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"returnFields":{"type":"array","items":{"type":"string"}},"expand":{"type":"array","items":{"type":"string"}},"types":{"type":"array","description":"Resource Domain type","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/SearchCriteria"}},"aggregations":{"type":"array","items":{"$ref":"#/definitions/SearchAggregation"}}}},"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}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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","inactive","deleted"]},"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"}}},"CoverSheet":{"type":"object","properties":{"notes":{"type":"string","description":"Text to be added to the coversheet"},"locale":{"type":"string","description":"Locale, e.g. = en-US"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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}}},"InitiateScreenRecording":{"type":"object","properties":{"recordACW":{"type":"boolean","default":false},"archiveRetention":{"$ref":"#/definitions/ArchiveRetention"},"deleteRetention":{"$ref":"#/definitions/DeleteRetention"}}},"CreateIntegrationRequest":{"type":"object","required":["integrationType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type."},"integrationType":{"description":"Type of the integration to create.","$ref":"#/definitions/IntegrationType"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details for an Integration"},"AnalyticsProperty":{"type":"object","required":["property","propertyType","value"],"properties":{"propertyType":{"type":"string","description":"Indicates what the data type is (e.g. integer vs string) and therefore how to evaluate what would constitute a match","enum":["bool","integer","real","date","string","uuid"]},"property":{"type":"string","description":"User-defined rather than intrinsic system-observed values. These are tagged onto segments by other components within PureCloud or by API users directly.  This is the name of the user-defined property."},"value":{"type":"string","description":"What property value to match against"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ArchitectAuditMessageListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ArchitectAuditMessage"}},"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"}}},"Vpn":{"type":"object","properties":{"type":{"type":"string"},"ip":{"type":"string"},"psk":{"type":"string"}}},"AuditUser":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"display":{"type":"string"}}},"GroupSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"startValue":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}},"value":{"type":"string"},"operator":{"type":"string","enum":["AND","OR","NOT"]},"group":{"type":"array","items":{"$ref":"#/definitions/GroupSearchCriteria"}},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS"]}}},"IntegrationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Integration"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"disabled":{"type":"boolean","default":false},"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","description":"The type of the condition","enum":["wrapupCondition","contactAttributeCondition","phoneNumberCondition","phoneNumberTypeCondition","callAnalysisCondition"]},"inverted":{"type":"boolean","description":"Indicates whether to evaluate for the opposite of the stated condition; default is false","default":false},"attributeName":{"type":"string","description":"An attribute name associated with the condition (applies only to certain rule conditions)"},"value":{"type":"string","description":"A value associated with the condition"},"valueType":{"type":"string","description":"Determines the type of the value associated with the condition","enum":["STRING","NUMERIC","DATETIME","PERIOD"]},"operator":{"type":"string","description":"An operation type for condition evaluation","enum":["EQUALS","LESS_THAN","LESS_THAN_EQUALS","GREATER_THAN","GREATER_THAN_EQUALS","CONTAINS","BEGINS_WITH","ENDS_WITH","BEFORE","AFTER"]},"codes":{"type":"array","description":"List of wrap-up code identifiers (used only in conditions of type 'wrapupCondition')","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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"languageDefault":{"type":"boolean","default":false},"tags":{"type":"object","additionalProperties":{"type":"array","items":{"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"}}},"RecordingSettings":{"type":"object","properties":{"maxSimultaneousStreams":{"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"}},"includeShares":{"type":"boolean","default":false}}},"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"}}}},"AggregationRange":{"type":"object","properties":{"gte":{"type":"number","description":"Greater than or equal to"},"lt":{"type":"number","description":"Less than"}}},"SceneGroup":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"queue":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AuditFacet":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"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"}},"includeNonAcd":{"type":"boolean","description":"If true, then track non-ACD conversations against utilization","default":false}}},"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}}},"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","inactive","deleted"]},"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}}},"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"}}}},"ContactPhoneNumberColumn":{"type":"object","required":["columnName","type"],"properties":{"columnName":{"type":"string","description":"name of the phone column"},"type":{"type":"string","description":"type of the phone column, for example, 'cell' or 'home'"},"callableTimeColumn":{"type":"string","description":"name of the column indicating the timezone to be considered for determining callable times"}}},"TrunkEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Trunk"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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}}},"SocialMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected on 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 this participant when disconnected on the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"purpose":{"type":"string","description":"The participant's purpose.  Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state.  Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","CONVERTING","UPLOADING","TRANSMITTING","NONE"]},"direction":{"type":"string","description":"The participant's direction.  Values can be: 'inbound' or 'outbound'","enum":["INBOUND","OUTBOUND"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold.","default":false},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up.","default":false},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/UriReference"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/UriReference"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorBody"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/UriReference"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up.","default":false},"socialMediaId":{"type":"string","description":"The social media ID used by this participant."},"socialMediaHub":{"type":"string","description":"The social media hub used by this participant."},"socialUserName":{"type":"string","description":"The social media user name used by this participant."},"previewText":{"type":"string","description":"Some preview text for this participant."}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"JsonNode":{"type":"object","properties":{"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"float":{"type":"boolean","default":false},"boolean":{"type":"boolean","default":false},"number":{"type":"boolean","default":false},"object":{"type":"boolean","default":false},"pojo":{"type":"boolean","default":false},"integralNumber":{"type":"boolean","default":false},"floatingPointNumber":{"type":"boolean","default":false},"short":{"type":"boolean","default":false},"int":{"type":"boolean","default":false},"long":{"type":"boolean","default":false},"double":{"type":"boolean","default":false},"bigDecimal":{"type":"boolean","default":false},"bigInteger":{"type":"boolean","default":false},"textual":{"type":"boolean","default":false},"binary":{"type":"boolean","default":false},"valueNode":{"type":"boolean","default":false},"containerNode":{"type":"boolean","default":false},"missingNode":{"type":"boolean","default":false},"array":{"type":"boolean","default":false},"null":{"type":"boolean","default":false}}},"SubscriberResponse":{"type":"object","properties":{"messageReturned":{"type":"array","items":{"type":"string"}},"status":{"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","inactive","deleted"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"mediaSettings":{"type":"object","additionalProperties":{"$ref":"#/definitions/MediaSetting"}},"bullseye":{"$ref":"#/definitions/Bullseye"},"acwSettings":{"$ref":"#/definitions/AcwSettings"},"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"}}}},"KeywordSet":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"queue":{"$ref":"#/definitions/Queue"},"language":{"type":"string"},"agents":{"type":"array","items":{"$ref":"#/definitions/User"}},"keywords":{"type":"array","items":{"$ref":"#/definitions/Keyword"}},"participantPurposes":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["AGENT","CUSTOMER"]}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Asset":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"downloadUrl":{"type":"string","format":"url"},"fileSizeBytes":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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","inactive","deleted"]},"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"}},"phoneTrunkBases":{"type":"array","description":"Trunk base settings of trunkType \"PHONE\" to inherit to edge logical interface for phone communication.","items":{"$ref":"#/definitions/UriReference"}},"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"}}},"StatisticalSummary":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"},"count":{"type":"integer","format":"int64"},"sum":{"type":"number"},"current":{"type":"number"},"ratio":{"type":"number"},"numerator":{"type":"number"},"denominator":{"type":"number"},"target":{"type":"number"}}},"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}}},"SocialConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/SocialMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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","inactive","deleted"]},"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}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"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","inactive","deleted"]},"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}}},"CampaignDiagnostics":{"type":"object","properties":{"callableContacts":{"description":"Campaign properties that can impact which contacts are callable","readOnly":true,"$ref":"#/definitions/CallableContactsDiagnostic"},"queueUtilizationDiagnostic":{"description":"Information regarding the campaign's queue","readOnly":true,"$ref":"#/definitions/QueueUtilizationDiagnostic"},"outstandingInteractionsCount":{"type":"integer","format":"int32","description":"Current number of outstanding interactions on the campaign","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"}}}},"AnalyticsSession":{"type":"object","properties":{"mediaType":{"type":"string","enum":["voice","chat","email","callback"]},"sessionId":{"type":"string"},"addressOther":{"type":"string"},"addressSelf":{"type":"string"},"ani":{"type":"string"},"direction":{"type":"string","enum":["inbound","outbound"]},"dnis":{"type":"string"},"outboundCampaignId":{"type":"string"},"outboundContactId":{"type":"string"},"outboundContactListId":{"type":"string"},"dispositionAnalyzer":{"type":"string"},"dispositionName":{"type":"string"},"edgeId":{"type":"string"},"remoteNameDisplayable":{"type":"string"},"roomId":{"type":"string"},"monitoredSessionId":{"type":"string"},"monitoredParticipantId":{"type":"string"},"segments":{"type":"array","items":{"$ref":"#/definitions/AnalyticsConversationSegment"}}}},"Snapshot":{"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}}},"UserSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string"},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"returnFields":{"type":"array","items":{"type":"string"}},"expand":{"type":"array","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/UserSearchCriteria"}}}},"AuthzPermissionContext":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"]}}},"UsersSearchResponse":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"previousPage":{"type":"string"},"currentPage":{"type":"string"},"nextPage":{"type":"string"},"types":{"type":"array","items":{"type":"string"}},"results":{"type":"array","items":{"$ref":"#/definitions/User"}},"aggregations":{"type":"array","items":{"$ref":"#/definitions/User"}}}},"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},"description":{"type":"string"},"schema":{"type":"object","additionalProperties":{"type":"object"}}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UnreadMetric":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The count of unread alerts for a specific rule type."}}},"Trunk":{"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","inactive","deleted"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"trunkType":{"type":"string","description":"The type of this trunk.","enum":["EXTERNAL","PHONE","EDGE"]},"edge":{"description":"The Edge using this trunk.","$ref":"#/definitions/UriReference"},"trunkBase":{"description":"The trunk base configuration used on this trunk.","$ref":"#/definitions/UriReference"},"trunkMetabase":{"description":"The metabase used to create this trunk.","$ref":"#/definitions/UriReference"},"edgeGroup":{"description":"The edge group associated with this trunk.","$ref":"#/definitions/UriReference"},"enabled":{"type":"boolean","description":"True if this trunk is in-service.  This comes from the trunk_enabled property of the referenced trunk base.","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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","required":["version"],"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"},"domain":{"type":"string"},"version":{"type":"integer","format":"int32","description":"The current version of the organization."},"state":{"type":"string","enum":["active","inactive","deleted"]},"defaultSiteId":{"type":"string"},"deletable":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AuthzGrant":{"type":"object","properties":{"permissionContext":{"$ref":"#/definitions/AuthzPermissionContext"},"role":{"$ref":"#/definitions/AuthzGrantRole"},"grantMadeAt":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SuggestSearchCriteria":{"type":"object","properties":{"endValue":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"startValue":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}},"value":{"type":"string"},"operator":{"type":"string","enum":["AND","OR","NOT"]},"group":{"type":"array","items":{"$ref":"#/definitions/SuggestSearchCriteria"}}}},"EmailMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/EmailMediaPolicyConditions"}}},"InteractionStatsRule":{"type":"object","required":["alertTypes","dimension","dimensionValue","enabled","mediaType","metric","name","notificationUsers","numericRange","statistic","value"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the rule"},"dimension":{"type":"string","description":"The dimension of concern.","enum":["queueId","userId"]},"dimensionValue":{"type":"string","description":"The value of the dimension."},"metric":{"type":"string","description":"The metric to be assessed.","enum":["tAbandon","tAnswered","tTalk","nOffered","tHandle","nTransferred","oServiceLevel","tWait","tHeld","tAcw"]},"mediaType":{"type":"string","description":"The media type.","enum":["voice","chat","email"]},"numericRange":{"type":"string","description":"The comparison descriptor used against the metric's value.","enum":["gt","gte","lt","lte","eq","ne"]},"statistic":{"type":"string","description":"The statistic of concern for the metric.","enum":["count","min","ratio","max"]},"value":{"type":"number","format":"double","description":"The threshold value."},"enabled":{"type":"boolean","description":"Indicates if the rule is enabled.","default":false},"inAlarm":{"type":"boolean","description":"Indicates if the rule is in alarm state.","readOnly":true,"default":false},"notificationUsers":{"type":"array","description":"The ids of users who will be notified of alarm state change.","uniqueItems":true,"items":{"$ref":"#/definitions/User"}},"alertTypes":{"type":"array","description":"A collection of notification methods. = ['SMS', 'DEVICE', 'EMAIL']","uniqueItems":true,"items":{"type":"string","enum":["SMS","DEVICE","EMAIL"]}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SystemPresence":{"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}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","COMMUNICATING"]},"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"},"disabled":{"type":"boolean","default":false},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}},"description":"Query result list"},"CallMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/CallMediaPolicyConditions"}}},"BillingAddress":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"street":{"type":"string"},"city":{"type":"string"},"countryName":{"type":"string"},"stateName":{"type":"string"},"postalCode":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContentSortItem":{"type":"object","properties":{"name":{"type":"string"},"ascending":{"type":"boolean","default":false}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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","inactive","deleted"]},"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"},"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/CallMediaPolicy"},"chatPolicy":{"description":"Conditions and actions for chats","$ref":"#/definitions/ChatMediaPolicy"},"emailPolicy":{"description":"Conditions and actions for emails","$ref":"#/definitions/EmailMediaPolicy"}}},"BatchItemBody":{"type":"object","properties":{"name":{"type":"string"}}},"Usage":{"type":"object","properties":{"types":{"type":"array","items":{"$ref":"#/definitions/UsageItem"}}}},"AnalyticsQueryFilter":{"type":"object","properties":{"type":{"type":"string","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/AnalyticsQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value). These can be one of three types: dimension, property, metric.","items":{"$ref":"#/definitions/AnalyticsQueryPredicate"}}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","required":["columnNames","phoneColumns"],"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 time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"columnNames":{"type":"array","description":"the contact column names","items":{"type":"string"}},"phoneColumns":{"type":"array","description":"the columns containing phone numbers","items":{"$ref":"#/definitions/ContactPhoneNumberColumn"}},"importStatus":{"description":"the status of the import process","readOnly":true,"$ref":"#/definitions/ImportStatus"},"previewModeColumnName":{"type":"string","description":"the name of the column that holds the indicators for contacts that are to be dialed in preview mode only"},"previewModeAcceptedValues":{"type":"array","description":"list of user-defined values indicating the contact is to be dialed in preview mode only","items":{"type":"string"}},"size":{"type":"integer","format":"int64","description":"the number of contacts in the contact list","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BillingContactListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/BillingContact"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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}}},"AnalyticsConversation":{"type":"object","properties":{"conversationId":{"type":"string"},"conversationStart":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"participants":{"type":"array","items":{"$ref":"#/definitions/AnalyticsParticipant"}},"evaluations":{"type":"array","items":{"$ref":"#/definitions/AnalyticsEvaluation"}}}},"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","SUBFLOWCALL"]},"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},"publishStatus":{"type":"string","enum":["STARTED","PENDING_VXMLGEN","PENDING_EDGE_CONFIG","SUCCESS","FAILURE"]},"publishedBy":{"$ref":"#/definitions/UriReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ChatConversationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ChatConversation"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AuditEntity":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string"}}},"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"}}}},"UserMe":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"Auto populated from addresses.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"state":{"type":"string","description":"The current state for this user.","readOnly":true,"enum":["active","inactive","deleted"]},"title":{"type":"string"},"username":{"type":"string"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"Required when updating. Version must be the current version. Only the system can assign version.","readOnly":true},"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"},"date":{"description":"The PureCloud system date time.","readOnly":true,"$ref":"#/definitions/ServerDate"},"geolocationSettings":{"description":"Geolocation settings for user's organization.","readOnly":true,"$ref":"#/definitions/GeolocationSettings"},"organization":{"description":"Organization details for this user.","readOnly":true,"$ref":"#/definitions/Organization"},"presenceDefinitions":{"type":"array","description":"The first 100 presence definitions for user's organization.","readOnly":true,"items":{"$ref":"#/definitions/OrganizationPresence"}},"locations":{"type":"array","description":"The first 100 locations for user's organization","readOnly":true,"items":{"$ref":"#/definitions/Location"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PolicyErrors":{"type":"object","properties":{"policyErrorMessages":{"type":"array","items":{"$ref":"#/definitions/PolicyErrorMessage"}}}},"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}}},"CallCommand":{"type":"object","properties":{"callNumber":{"type":"string"}}},"BillingPendingTask":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"task":{"$ref":"#/definitions/BillingTaskResult"},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","TRANSFER_FORWARD","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"},"disconnectedTime":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"KeywordSetEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/KeywordSet"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WorkItemSearchDetails":{"type":"object","properties":{"workItem":{"$ref":"#/definitions/WorkItemDetails"}},"description":"WorkItem entry found in result to a search."},"ExternalDataSource":{"type":"object","properties":{"platform":{"type":"string"},"url":{"type":"string"}},"description":"Describes a link to a record in an external system that contributed data to a Relate record"},"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}}},"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","US_TOLLFREE","XA_TOLLFREE","XB_TOLLFREE","XC_TOLLFREE","AG_DID","AI_DID","BB_DID","BM_DID","BS_DID","CA_DID","DM_DID","DO_DID","GD_DID","JM_DID","KN_DID","KY_DID","KZ_DID","LC_DID","MP_DID","MS_DID","RU_DID","TC_DID","TT_DID","US_DID","VC_DID","VG_DID","AF_DID","AR_DID","AT_DID","AU_DID","BE_DID","BR_DID","CH_DID","CL_DID","CN_DID","CO_DID","CU_DID","DE_DID","DK_DID","EG_DID","ES_DID","FR_DID","GB_DID","GR_DID","HU_DID","ID_DID","IN_DID","IR_DID","IT_DID","JP_DID","KR_DID","LK_DID","MM_DID","MX_DID","MY_DID","NL_DID","NO_DID","NZ_DID","PE_DID","PH_DID","PK_DID","PL_DID","RO_DID","SE_DID","SG_DID","TH_DID","TR_DID","VE_DID","VN_DID","ZA_DID","AD_DID","AE_DID","AL_DID","AM_DID","AO_DID","AQ_DID","AW_DID","AZ_DID","BA_DID","BD_DID","BF_DID","BG_DID","BH_DID","BI_DID","BJ_DID","BL_DID","BN_DID","BO_DID","BQ_DID","BT_DID","BW_DID","BY_DID","BZ_DID","CD_DID","CF_DID","CG_DID","CI_DID","CK_DID","CM_DID","CR_DID","CV_DID","CY_DID","CZ_DID","DJ_DID","DZ_DID","EC_DID","EE_DID","EH_DID","ER_DID","ET_DID","FI_DID","FJ_DID","FK_DID","FM_DID","FO_DID","GA_DID","GE_DID","GF_DID","GH_DID","GI_DID","GL_DID","GM_DID","GN_DID","GP_DID","GQ_DID","GT_DID","GW_DID","GY_DID","HK_DID","HN_DID","HR_DID","HT_DID","IE_DID","IL_DID","IO_DID","IQ_DID","IS_DID","JO_DID","KE_DID","KG_DID","KH_DID","KI_DID","KM_DID","KP_DID","KW_DID","LA_DID","LB_DID","LI_DID","LR_DID","LS_DID","LT_DID","LU_DID","LV_DID","LY_DID","MA_DID","MC_DID","MD_DID","ME_DID","MF_DID","MG_DID","MH_DID","MK_DID","ML_DID","MN_DID","MO_DID","MQ_DID","MR_DID","MT_DID","MU_DID","MV_DID","MW_DID","MZ_DID","NA_DID","NC_DID","NE_DID","NF_DID","NG_DID","NI_DID","NP_DID","NR_DID","NU_DID","OM_DID","PA_DID","PF_DID","PG_DID","PM_DID","PS_DID","PT_DID","PW_DID","PY_DID","QA_DID","RE_DID","RS_DID","RW_DID","SA_DID","SB_DID","SC_DID","SD_DID","SH_247_DID","SH_290_DID","SI_DID","SK_DID","SL_DID","SM_DID","SN_DID","SO_DID","SR_DID","SS_DID","ST_DID","SV_DID","SY_DID","SZ_DID","TD_DID","TG_DID","TJ_DID","TK_DID","TL_DID","TM_DID","TN_DID","TO_DID","TV_DID","TW_DID","TZ_DID","UA_DID","UG_DID","UY_DID","UZ_DID","VU_DID","WF_DID","WS_DID","XG_DID","XN_DID","XV_882_DID","XV_883_DID","YE_DID","YT_DID","ZM_DID","ZW_DID","SX_DID"]}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PropertyIndexRequest":{"type":"object","required":["properties"],"properties":{"sessionId":{"type":"string","description":"Attach properties to a segment in the indicated session. Also requires a timestamp."},"timestamp":{"type":"integer","format":"int64","description":"Attach properties to a segment covering a specific point in time. Also requries a sessionId."},"properties":{"type":"array","description":"The list of properties to index","items":{"$ref":"#/definitions/AnalyticsProperty"}}}},"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","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}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"UsageItem":{"type":"object","properties":{"type":{"type":"string","enum":["RECORDING","FAX","DOCUMENT","ALL"]},"totalDocumentByteCount":{"type":"integer","format":"int64"},"totalDocumentCount":{"type":"integer","format":"int64"}}},"IntegrationConfiguration":{"type":"object","required":["advanced","properties","version"],"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."},"propertiesSchemaUri":{"type":"string","description":"URI for the JSON Schema describing the configuration properties in the properties field.","readOnly":true},"advancedSchemaUri":{"type":"string","description":"URI for the JSON Schema describing the advanced configuration","readOnly":true},"properties":{"type":"object","description":"Key-value configuration settings described by the schema in the propertiesSchemaUri field."},"advanced":{"type":"object","description":"Advanced configuration described by the schema in the advancedSchemaUri field."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Configuration for an Integration"},"SuggestSearchRequest":{"type":"object","required":["types"],"properties":{"types":{"type":"array","description":"Resource Domain type","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/SuggestSearchCriteria"}}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"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"}}}},"AuthzObject":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"lastModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"permissionContexts":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/AuthzPermissionContext"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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"}},"permissionPolicies":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"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"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}}},"Waypoint":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"targetScene":{"$ref":"#/definitions/Scene"},"rotationY":{"type":"number","format":"double"},"rotationX":{"type":"number","format":"double"},"sceneRotationY":{"type":"number","format":"double"},"distance":{"type":"number","format":"double"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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}}},"CallableContactsDiagnostic":{"type":"object","properties":{"dncLists":{"type":"array","description":"Do not call lists for the campaign","readOnly":true,"items":{"$ref":"#/definitions/UriReference"}},"callableTimeSet":{"description":"Callable time sets for the campaign","readOnly":true,"$ref":"#/definitions/UriReference"},"ruleSets":{"type":"array","description":"Rule sets for the campaign","readOnly":true,"items":{"$ref":"#/definitions/UriReference"}}}},"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}}},"MemberEntity":{"type":"object","properties":{"id":{"type":"string"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AnalyticsConversationSegment":{"type":"object","properties":{"segmentStart":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"segmentEnd":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"queueId":{"type":"string"},"wrapUpCode":{"type":"string"},"wrapUpNote":{"type":"string"},"wrapUpTags":{"type":"array","items":{"type":"string"}},"errorCode":{"type":"string"},"disconnectType":{"type":"string","enum":["endpoint","client","system","transfer","error","peer","other","spam","transportFailure","conferenceTransfer","consultTransfer","forwardTransfer"]},"segmentType":{"type":"string","enum":["unknown","alert","system","delay","hold","interact","ivr","dialing","wrapup","voicemail"]},"requestedRoutingUserIds":{"type":"array","items":{"type":"string"}},"requestedRoutingSkillIds":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"requestedLanguageId":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/definitions/AnalyticsProperty"}},"sourceConversationId":{"type":"string"},"destinationConversationId":{"type":"string"},"sourceSessionId":{"type":"string"},"destinationSessionId":{"type":"string"},"sipResponseCodes":{"type":"array","items":{"type":"integer","format":"int64"}},"q850ResponseCodes":{"type":"array","items":{"type":"integer","format":"int64"}},"conference":{"type":"boolean","default":false},"groupId":{"type":"string"},"subject":{"type":"string"}}},"OAuthClient":{"type":"object","required":["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."},"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 and client credential 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"}},"authorizedGrantType":{"type":"string","description":"The OAuth Grant/Client type supported by this client.\nCode Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured.\nImplicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured.\nSAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint.\nClient Credential grant type - Used to created access tokens that are tied only to the client.\n","enum":["CODE","TOKEN","SAML2BEARER","PASSWORD","CLIENT_CREDENTIALS"]},"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"}}},"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}}},"MediaResult":{"type":"object","properties":{"mediaUri":{"type":"string"},"waveformData":{"type":"array","items":{"type":"number","format":"float"}}}},"ResponseSet":{"type":"object","required":["responses"],"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 time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"responses":{"type":"object","description":"Map of disposition identifiers to reactions. For example: {\"disposition.classification.callable.person\": {\"reactionType\": \"transfer\"}}","additionalProperties":{"$ref":"#/definitions/Reaction"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GreetingAudioFile":{"type":"object","properties":{"durationMilliseconds":{"type":"integer","format":"int64"},"sizeBytes":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri"}}},"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/FlowHistoryDataItem"}},"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"},"MediaParticipantRequest":{"type":"object","properties":{"wrapup":{"description":"Wrap-up to assign to this participant.","$ref":"#/definitions/Wrapup"},"state":{"type":"string","description":"The state to update to set for this participant's communications.  Possible values are: 'connected' and 'disconnected'.","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","CONVERTING","UPLOADING","TRANSMITTING","NONE"]},"recording":{"type":"boolean","description":"True to enable recording of this participant, otherwise false to disable recording.","default":false},"muted":{"type":"boolean","description":"True to mute this conversation participant.","default":false},"confined":{"type":"boolean","description":"True to confine this conversation participant.  Should only be used for ad-hoc conferences","default":false},"held":{"type":"boolean","description":"True to hold this conversation participant.","default":false},"wrapupSkipped":{"type":"boolean","description":"True to skip wrap-up for this participant.","default":false}}},"Gateway":{"type":"object","properties":{"id":{"type":"string"},"ip":{"type":"string"},"port":{"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","inactive","deleted"]},"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"},"webRtcUser":{"description":"This is the user associated with a WebRTC type phone.  It is required for all WebRTC phones.","$ref":"#/definitions/UriReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"startValue":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}},"value":{"type":"string"},"operator":{"type":"string","enum":["AND","OR","NOT"]},"group":{"type":"array","items":{"$ref":"#/definitions/UserSearchCriteria"}},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS"]}}},"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."},"AnalyticsParticipant":{"type":"object","properties":{"participantId":{"type":"string"},"participantName":{"type":"string"},"userId":{"type":"string"},"purpose":{"type":"string","enum":["manual","dialer","inbound","acd","ivr","voicemail","outbound","agent","user","station","group","customer","external"]},"sessions":{"type":"array","items":{"$ref":"#/definitions/AnalyticsSession"}}}},"VendorConnectionRequest":{"type":"object","properties":{"publisher":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}},"DeleteRetention":{"type":"object","properties":{"days":{"type":"integer","format":"int32"}}},"Integration":{"type":"object","required":["name","state","version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type."},"integrationType":{"description":"Type of the integration","readOnly":true,"$ref":"#/definitions/IntegrationType"},"state":{"type":"string","description":"Configured state of the integration.","enum":["ENABLED","DISABLED","DELETED"]},"config":{"description":"Configuration for the integration.","readOnly":true,"$ref":"#/definitions/IntegrationConfiguration"},"lastStatus":{"description":"Last reported status of the integration.","readOnly":true,"$ref":"#/definitions/IntegrationStatusInfo"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details for an Integration"},"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/ContentFilterItem"}},"attributeFilters":{"type":"array","items":{"$ref":"#/definitions/AttributeFilterItem"}},"includeShares":{"type":"boolean","default":false}}},"PresenceQueryResponse":{"type":"object","properties":{"systemToOrganizationMappings":{"type":"object","description":"A mapping from system presence to a list of organization presence ids","additionalProperties":{"type":"array","items":{"type":"string"}}},"results":{"type":"array","items":{"$ref":"#/definitions/AggregateDataContainer"}}}},"FaxSummary":{"type":"object","properties":{"readCount":{"type":"integer","format":"int32"},"unreadCount":{"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int32"}}},"CallMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"},"directions":{"type":"array","items":{"type":"string","enum":["INBOUND","OUTBOUND"]}},"duration":{"$ref":"#/definitions/DurationCondition"}}},"BatchReply":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/BatchReplyItem"}}}},"AssetEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Scene"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserPresence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"source":{"type":"string","description":"Represents the source where the Presence was set. Some examples are: PURECLOUD, LYNC, OUTLOOK, etc."},"primary":{"type":"boolean","description":"A boolean used to tell whether or not to set this presence source as the primary on a PATCH","default":false},"presenceDefinition":{"$ref":"#/definitions/OrganizationPresence"},"message":{"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}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"InteractionStatsAlertContainer":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/InteractionStatsAlert"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Callback":{"type":"object","properties":{"state":{"type":"string","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","SCHEDULED","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","TRANSFER_FORWARD","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"},"disconnectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"callbackScheduledTime":{"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}}},"AuthzGrantPolicy":{"type":"object","properties":{"actions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"condition":{"type":"string"},"domain":{"type":"string"},"entityName":{"type":"string"}}},"FlowTerminateRequest":{"type":"object","properties":{"reason":{"type":"string","description":"Reason code for a termination."}},"description":"Passed into a terminate command to customize the termination action."},"PagingSpec":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32","description":"How many results per page"},"pageNumber":{"type":"integer","format":"int32","description":"How many pages in"}}},"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","inactive","deleted"]},"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/SubscriberResponse"}}},"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"}},"description":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CallbackConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/CallbackMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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","required":["error"],"properties":{"error":{"type":"string","description":"name of the error","readOnly":true},"details":{"type":"string","description":"additional information regarding the error","readOnly":true}}},"Thumbnail":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"downloadUrl":{"type":"string","format":"url"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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}}},"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"}}},"PortBillingAddress":{"type":"object","properties":{"streetAddress":{"type":"string"},"cityProvince":{"type":"string"},"state":{"type":"string"},"zipPostal":{"type":"string"},"country":{"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","inactive","deleted"]},"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}}},"SceneGroupEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/SceneGroup"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Currency":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"decimalPlaces":{"type":"integer","format":"int32"},"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","inactive","deleted"]},"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}}},"LocationAddress":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"countryName":{"type":"string"},"state":{"type":"string"},"street1":{"type":"string"},"street2":{"type":"string"},"zipcode":{"type":"string"}}},"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"}}},"ConversationAssociation":{"type":"object","required":["communicationId","conversationId","mediaType"],"properties":{"conversationId":{"type":"string","description":"Conversation ID"},"communicationId":{"type":"string","description":"Communication ID"},"mediaType":{"type":"string","description":"Media type","enum":["CALL","CALLBACK","CHAT","EMAIL","SOCIAL_EXPRESSION","VIDEO"]}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactCallbackRequest":{"type":"object","required":["campaignId","contactId","contactListId","phoneColumn","schedule"],"properties":{"campaignId":{"type":"string","description":"Campaign identifier"},"contactListId":{"type":"string","description":"Contact list identifier"},"contactId":{"type":"string","description":"Contact identifier"},"phoneColumn":{"type":"string","description":"Name of the phone column containing the number to be called"},"schedule":{"type":"string","description":"The scheduled time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ\", example = \"2016-01-02T16:59:59\""}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"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","SUBFLOWCALLFLOW","SYSTEMPROMPT","USER","USERPROMPT","VOICEXML"]},"deleted":{"type":"boolean","default":false},"updated":{"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":{"description":"Identifier of the queue","readOnly":true,"$ref":"#/definitions/UriReference"},"usersInQueue":{"type":"integer","format":"int32","description":"The number of users joined to the queue","readOnly":true},"activeUsersInQueue":{"type":"integer","format":"int32","description":"The number of users active on the queue","readOnly":true},"usersOnQueue":{"type":"integer","format":"int32","description":"The number of users with a status of on-queue","readOnly":true},"usersNotUtilized":{"type":"integer","format":"int32","description":"The number of users in the queue currently not engaged","readOnly":true},"usersOnQueueWithStation":{"type":"integer","format":"int32","description":"The number of users in the queue with a station","readOnly":true},"usersOnACampaignCall":{"type":"integer","format":"int32","description":"The number of users currently engaged in a campaign call","readOnly":true},"usersOnDifferentEdgeGroup":{"type":"integer","format":"int32","description":"The number of users whose station is homed to an edge different from the campaign","readOnly":true},"usersOnANonCampaignCall":{"type":"integer","format":"int32","description":"The number of users currently engaged in a communication that is not part of the campaign","readOnly":true}}},"CampaignProgress":{"type":"object","required":["campaign","contactList"],"properties":{"campaign":{"description":"Identifier of the campaign","$ref":"#/definitions/UriReference"},"contactList":{"description":"Identifier of the contact list","$ref":"#/definitions/UriReference"},"numberOfContactsCalled":{"type":"integer","format":"int64","description":"Number of contacts processed during the campaign","readOnly":true},"totalNumberOfContacts":{"type":"integer","format":"int64","description":"Total number of contacts in the campaign","readOnly":true},"percentage":{"type":"integer","format":"int64","description":"Percentage of contacts processed during the campaign","readOnly":true}}},"DomainNetworkAddress":{"type":"object","properties":{"type":{"type":"string"},"address":{"type":"string"},"persistent":{"type":"boolean","default":false},"family":{"type":"integer","format":"int32"}}},"CallConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/CallMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"recordingState":{"type":"string","enum":["NONE","ACTIVE","PAUSED"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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}}},"EmailMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"}}},"AuthzPerm":{"type":"object","properties":{"name":{"type":"string"},"permitted":{"type":"boolean","default":false}}},"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"},"externalContactId":{"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},"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/ConversationChat"}},"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","GROUP"]},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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}}},"MediaSummaryDetail":{"type":"object","properties":{"active":{"type":"integer","format":"int32"},"acw":{"type":"integer","format":"int32"}}},"InteractionStatsAlert":{"type":"object","required":["alertTypes","dimension","dimensionValue","mediaType","metric","name","notificationUsers","numericRange","ruleId","startDate","statistic","unread","value"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the rule that generated the alert","readOnly":true},"dimension":{"type":"string","description":"The dimension of concern.","readOnly":true,"enum":["queueId","userId"]},"dimensionValue":{"type":"string","description":"The value of the dimension.","readOnly":true},"metric":{"type":"string","description":"The metric to be assessed.","readOnly":true,"enum":["tAbandon","tAnswered","tTalk","nOffered","tHandle","nTransferred","oServiceLevel","tWait","tHeld","tAcw"]},"mediaType":{"type":"string","description":"The media type.","readOnly":true,"enum":["voice","chat","email"]},"numericRange":{"type":"string","description":"The comparison descriptor used against the metric's value.","readOnly":true,"enum":["gt","gte","lt","lte","eq","ne"]},"statistic":{"type":"string","description":"The statistic of concern for the metric.","readOnly":true,"enum":["count","min","ratio","max"]},"value":{"type":"number","format":"double","description":"The threshold value.","readOnly":true},"ruleId":{"type":"string","description":"The id of the rule.","readOnly":true},"unread":{"type":"boolean","description":"Indicates if the alert has been read.","default":false},"startDate":{"type":"string","format":"date-time","description":"The date/time the alert was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"endDate":{"type":"string","format":"date-time","description":"The date/time the owning rule exiting in alarm status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"notificationUsers":{"type":"array","description":"The ids of users who were notified of alarm state change.","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/User"}},"alertTypes":{"type":"array","description":"A collection of notification methods. = ['SMS', 'DEVICE', 'EMAIL']","readOnly":true,"uniqueItems":true,"items":{"type":"string","enum":["SMS","DEVICE","EMAIL"]}},"ruleUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SequenceSchedule":{"type":"object","required":["intervals","sequence","timeZone"],"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 time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"intervals":{"type":"array","description":"a list of start and end times","items":{"$ref":"#/definitions/ScheduleInterval"}},"timeZone":{"type":"string","example":"Africa/Abidjan","description":"time zone identifier to be applied to the intervals; for example Africa/Abidjan"},"sequence":{"description":"identifier of the sequence to be scheduled","$ref":"#/definitions/UriReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Group":{"type":"object","required":["rulesVisible","type","visibility"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"memberCount":{"type":"integer","format":"int64","description":"Number of members.","readOnly":true},"state":{"type":"string","description":"Active, inactive, or deleted state.","readOnly":true,"enum":["active","inactive","deleted"]},"version":{"type":"integer","format":"int32","description":"Current version for this resource.","readOnly":true},"type":{"type":"string","description":"Type of group.","enum":["social","official"]},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/Contact"}},"rulesVisible":{"type":"boolean","description":"Are membership rules visible to the person requesting to view the group","default":false},"visibility":{"type":"string","description":"Who can view this group","enum":["public","owners","members"]},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AvailableLanguageList":{"type":"object","properties":{"languages":{"type":"array","items":{"type":"string"}}}},"UserImage":{"type":"object","properties":{"resolution":{"type":"string","description":"Height and/or width of image. ex: 640x480 or x128"},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","required":["callableTimes"],"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 time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"callableTimes":{"type":"array","description":"list of time/timezone groupings for which it is acceptable to place outbound calls","items":{"$ref":"#/definitions/CallableTime"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrunkRecordingEnabledCount":{"type":"object","properties":{"enabledCount":{"type":"integer","format":"int32","description":"The amount of trunks that have recording enabled"},"disabledCount":{"type":"integer","format":"int32","description":"The amount of trunks that do not have recording enabled"}}},"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/ResponseFilter"}}},"description":"Used to query for responses"},"DurationCondition":{"type":"object","properties":{"durationTarget":{"type":"string","enum":["DURATION","DURATION_RANGE"]},"durationOperator":{"type":"string"},"durationRange":{"type":"string"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SocialConversationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/SocialConversation"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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."}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WaypointEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Waypoint"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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}}},"ChannelTopic":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Topic id for subscription"},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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}}},"CustomerInteractionCenter":{"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"},"disabled":{"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","TRANSFER_FORWARD","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"},"connectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"disconnectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"disconnectReasons":{"type":"array","items":{"$ref":"#/definitions/DisconnectReason"}}}},"SupportCredit":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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"]},"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"]}}},"CallbackMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected on 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 this participant when disconnected on the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"purpose":{"type":"string","description":"The participant's purpose.  Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state.  Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","CONVERTING","UPLOADING","TRANSMITTING","NONE"]},"direction":{"type":"string","description":"The participant's direction.  Values can be: 'inbound' or 'outbound'","enum":["INBOUND","OUTBOUND"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold.","default":false},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up.","default":false},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/UriReference"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/UriReference"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorBody"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/UriReference"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up.","default":false},"outboundPreview":{"$ref":"#/definitions/DialerPreview"},"callbackNumbers":{"type":"array","items":{"type":"string"}},"callbackUserName":{"type":"string"},"skipEnabled":{"type":"boolean","default":false},"timeoutSeconds":{"type":"integer","format":"int32"},"callbackScheduledTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"PhonesReboot":{"type":"object","properties":{"phoneIds":{"type":"array","items":{"type":"string"}},"siteId":{"type":"string"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ManagementUnitTimezone":{"type":"object","properties":{"timezone":{"type":"string"}}},"Utilization":{"type":"object","properties":{"utilization":{"type":"object","description":"Map of media types to utilization settings.  Map keys can be: call, chat, email, or socialExpression","additionalProperties":{"$ref":"#/definitions/OrgMediaUtilization"}}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AuthzGrantRole":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"policies":{"type":"array","items":{"$ref":"#/definitions/AuthzGrantPolicy"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","inactive","deleted"]},"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},"inheritPhoneTrunkBasesIPv4":{"type":"boolean","description":"The IPv4 phone trunk base assignment will be inherited from the Edge Group.","default":false},"inheritPhoneTrunkBasesIPv6":{"type":"boolean","description":"The IPv6 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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowSearchRequest":{"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"},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"CampaignTimeSlot":{"type":"object","required":["day"],"properties":{"startTime":{"type":"string","example":"08:00:00","description":"interval start time as an ISO-8601 string. For example: HH:mm:ss"},"stopTime":{"type":"string","example":"16:59:59","description":"interval stop time as an ISO-8601 string. For example: HH:mm:ss"},"day":{"type":"integer","format":"int32","example":"1","description":"must be within [1-7], representing Monday through Sunday"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserStation":{"type":"object","properties":{"id":{"type":"string","description":"A globally unique identifier for this station","readOnly":true},"associatedUser":{"$ref":"#/definitions/User"},"associatedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"defaultUser":{"$ref":"#/definitions/User"},"providerInfo":{"type":"object","description":"Provider-specific info for this station, e.g. { \"edgeGroupId\": \"ffe7b15c-a9cc-4f4c-88f5-781327819a49\" }","additionalProperties":{"type":"string"}}}},"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":"Timestamp of the last attempt to reach this number. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"lastResult":{"type":"string","description":"Result of the last attempt to reach this number","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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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":{"description":"Evaluation form used for evaluation.","$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"},"neverRelease":{"type":"boolean","description":"Signifies if the evaluation is never to be released. This cannot be set true if release date is also set.","default":false},"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}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ConsultTransferResponse":{"type":"object","required":["destinationParticipantId"],"properties":{"destinationParticipantId":{"type":"string","description":"Participant ID to whom the call is being transferred."}}},"AggregateMetricData":{"type":"object","properties":{"metric":{"type":"string","enum":["tSegmentDuration","oTotalCriticalScore","oTotalScore","nEvaluations","tAbandon","tIvr","tAnswered","tAcd","tTalk","tHeld","tTalkComplete","tHeldComplete","tAcw","tHandle","tWait","tAgentRoutingStatus","tOrganizationPresence","tSystemPresence","tUserResponseTime","tAgentResponseTime","nOffered","nOverSla","nTransferred","nOutboundAttempted","nOutboundConnected","nOutboundAbandoned","nError","oServiceTarget","oServiceLevel","tActive","tInactive","oActiveUsers","oMemberUsers","oActiveQueues","oMemberQueues","oInteracting","oWaiting"]},"qualifier":{"type":"string"},"stats":{"$ref":"#/definitions/StatisticalSummary"}}},"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"}}},"CodesRequest":{"type":"object","properties":{"organizationId":{"type":"string"},"addCommunicationCode":{"type":"string"}}},"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","required":["callAnalysisResponseSet","campaignStatus","contactList","dialingMode","edgeGroup","phoneColumns","queue","script"],"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 time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"contactList":{"description":"identifier of the contact list for the campaign","$ref":"#/definitions/UriReference"},"queue":{"description":"identifier of the agent assignment queue, required for all dialing modes other than agentless","$ref":"#/definitions/UriReference"},"dialingMode":{"type":"string","description":"dialing mode of the campaign","enum":["agentless","preview","power","predictive","progressive"]},"script":{"description":"identifier of the campaign script, required for all dialing modes other than agentless","$ref":"#/definitions/UriReference"},"edgeGroup":{"description":"identifier of the edge group, required for all dialing modes other than preview","$ref":"#/definitions/UriReference"},"campaignStatus":{"type":"string","description":"status of the campaign; can be set to 'on' or 'off'"},"phoneColumns":{"type":"array","description":"the contact list phone columns to be called for the campaign","items":{"$ref":"#/definitions/PhoneColumn"}},"abandonRate":{"type":"number","format":"double","description":"the targeted abandon rate percentage"},"dncLists":{"type":"array","description":"identifiers of the do not call lists","items":{"$ref":"#/definitions/UriReference"}},"callableTimeSet":{"description":"the identifier of the callable time set","$ref":"#/definitions/UriReference"},"callAnalysisResponseSet":{"description":"the identifier of the call analysis response set, required for all dialing modes other than preview","$ref":"#/definitions/UriReference"},"errors":{"type":"array","description":"a list of current error conditions associated with the campaign","readOnly":true,"items":{"$ref":"#/definitions/RestErrorDetail"}},"callerName":{"type":"string","description":"caller id name to be displayed on the outbound call"},"callerAddress":{"type":"string","example":"[phone]","description":"caller id phone number to be displayed on the outbound call"},"outboundLineCount":{"type":"integer","format":"int32","description":"for agentless campaigns, the number of outbound lines to be concurrently dialed"},"ruleSets":{"type":"array","description":"identifiers of the rule sets","items":{"$ref":"#/definitions/UriReference"}},"skipPreviewDisabled":{"type":"boolean","description":"for preview campaigns, indicator of whether the agent can skip a preview without placing a call","default":false},"previewTimeOutSeconds":{"type":"integer","format":"int64","description":"for preview campaigns, number of seconds before a call will be automatically placed. A value of 0 indicates no automatic placement of calls"},"contactSort":{"description":"information determining the order in which the contacts will be dialed","$ref":"#/definitions/ContactSort"},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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.","enum":["text/plain","text/html"]}},"description":"Contains information about the text associated with a response."},"ContentFilterItem":{"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"}}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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}}},"ReplaceRequest":{"type":"object","properties":{"changeNumber":{"type":"integer","format":"int32"},"name":{"type":"string"},"authToken":{"type":"string"}}},"ConversationQuery":{"type":"object","properties":{"interval":{"type":"string","description":"Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"conversationFilters":{"type":"array","description":"Filters that target conversation-level data","items":{"$ref":"#/definitions/AnalyticsQueryFilter"}},"evaluationFilters":{"type":"array","description":"Filters that target quality management evaluation-level data","items":{"$ref":"#/definitions/AnalyticsQueryFilter"}},"segmentFilters":{"type":"array","description":"Filters that target individual segments within a conversation","items":{"$ref":"#/definitions/AnalyticsQueryFilter"}},"aggregations":{"type":"array","description":"Include faceted search and aggregate roll-ups describing your search results. This does not function as a filter, but rather, summary data about the data matching your filters","items":{"$ref":"#/definitions/AnalyticsQueryAggregation"}},"paging":{"description":"Page size and number to control iterating through large result sets. Default page size is 25","$ref":"#/definitions/PagingSpec"},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc"]},"orderBy":{"type":"string","description":"Specify which data element within the result set to use for sorting. The options  to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart","enum":["conversationStart","segmentStart","segmentEnd"]}}},"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"},"totalDocumentByteCount":{"type":"integer","format":"int64"}}},"UnreadStatus":{"type":"object","properties":{"unread":{"type":"boolean","description":"Sets if the alert is read or unread.","default":false}}},"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}}},"EdgeLogsJobUploadRequest":{"type":"object","properties":{"fileIds":{"type":"array","items":{"type":"string"}}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ConnectRate":{"type":"object","properties":{"attempts":{"type":"integer","format":"int64","description":"Number of call attempts made","readOnly":true},"connects":{"type":"integer","format":"int64","description":"Number of calls with a live voice detected","readOnly":true},"connectRatio":{"type":"number","format":"double","description":"Ratio of connects to attempts","readOnly":true}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"StatisticalResponse":{"type":"object","properties":{"interval":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/definitions/AggregateMetricData"}}}},"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"},"disabled":{"type":"boolean","default":false},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateCallbackResponse":{"type":"object","required":["callbackIdentifiers","conversation"],"properties":{"conversation":{"description":"The conversation associated with the callback","$ref":"#/definitions/UriReference"},"callbackIdentifiers":{"type":"array","description":"The list of communication identifiers for the callback participants","items":{"$ref":"#/definitions/CallbackIdentifier"}}}},"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","SUBFLOWCALLFLOW","SYSTEMPROMPT","USER","USERPROMPT","VOICEXML"]},"deleted":{"type":"boolean","default":false},"updated":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"]},"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","inactive","deleted"]},"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}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"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"}}}},"LocationSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"startValue":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}},"value":{"type":"string"},"operator":{"type":"string","enum":["AND","OR","NOT"]},"group":{"type":"array","items":{"$ref":"#/definitions/LocationSearchCriteria"}},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS"]}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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":{"$ref":"#/definitions/LocationAddress"},"addressVerified":{"type":"boolean","default":false},"emergencyNumber":{"$ref":"#/definitions/LocationEmergencyNumber"},"state":{"type":"string","description":"Current activity status of the location.","enum":["active","deleted"]},"version":{"type":"integer","format":"int32"},"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}}},"ObservationQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/ObservationDataContainer"}}}},"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"}}},"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"},"description":{"type":"string"}}},"ChatMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/ChatMediaPolicyConditions"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"VideoConversationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/VideoConversation"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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."}}},"NumericRange":{"type":"object","properties":{"gt":{"type":"number","description":"Greater than"},"gte":{"type":"number","description":"Greater than or equal to"},"lt":{"type":"number","description":"Less than"},"lte":{"type":"number","description":"Less than or equal to"}}},"CallbackConversationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/CallbackConversation"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DialerRule":{"type":"object","required":["category","conditions","name"],"properties":{"id":{"type":"string","description":"The identifier of the rule","readOnly":true},"name":{"type":"string","description":"The name of the rule"},"order":{"type":"integer","format":"int32","description":"The ranked order of the rule; rules are processed from lowest number to highest"},"category":{"type":"string","description":"The category of the rule","enum":["DIALER_PRECALL","DIALER_WRAPUP"]},"conditions":{"type":"array","description":"The list of rule conditions; all must evaluate to true to trigger the rule actions","items":{"$ref":"#/definitions/Condition"}},"actions":{"type":"array","description":"The list of rule actions to be taken if the conditions are true","items":{"$ref":"#/definitions/DialerAction"}}}},"SearchAggregation":{"type":"object","properties":{"field":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["COUNT","SUM","AVERAGE","CONTAINS","STARTS_WITH","ENDS_WITH"]},"value":{"type":"string"},"size":{"type":"integer","format":"int32"},"order":{"type":"array","items":{"type":"string","enum":["VALUE_DESC","VALUE_ASC","COUNT_DESC","COUNT_ASC"]}}}},"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"}}},"CreateCallRequest":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"The phone number to dial."},"callFromQueueId":{"type":"string","description":"The queue ID to call on behalf of."},"callQueueId":{"type":"string","description":"The queue ID to call."},"callUserId":{"type":"string","description":"The user ID to call."},"priority":{"type":"integer","format":"int32","description":"The priority to assign to this call (if calling a queue)."},"languageId":{"type":"string","description":"The language skill ID to use for routing this call (if calling a queue)."},"routingSkillsIds":{"type":"array","description":"The skill ID's to use for routing this call (if calling a queue).","items":{"type":"string"}},"conversationIds":{"type":"array","description":"The list of existing call conversations to merge into a new ad-hoc conference.","items":{"type":"string"}},"participants":{"type":"array","description":"The list of participants to call to create a new ad-hoc conference.","items":{"$ref":"#/definitions/Destination"}}}},"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"}}},"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","inactive","deleted"]},"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}}},"DialerAuditRequest":{"type":"object","properties":{"queryPhrase":{"type":"string"},"queryFields":{"type":"array","items":{"type":"string"}},"facets":{"type":"array","items":{"$ref":"#/definitions/AuditFacet"}},"filters":{"type":"array","items":{"$ref":"#/definitions/AuditFilter"}}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the integration type."},"name":{"type":"string"},"description":{"type":"string","description":"Localized description of the integration type.","readOnly":true},"provider":{"type":"string","description":"PureCloud provider of the integration type.","readOnly":true},"images":{"type":"array","description":"Collection of logos.","readOnly":true,"items":{"$ref":"#/definitions/UserImage"}},"configPropertiesSchemaUri":{"type":"string","description":"URI of the schema describing the key-value properties needed to configure an integration of this type.","readOnly":true},"configAdvancedSchemaUri":{"type":"string","description":"URI of the schema describing the advanced JSON document needed to configure an integration of this type.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Descriptor for a type of Integration."},"ContactAddress":{"type":"object","properties":{"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"countryCode":{"type":"string"}}},"InteractionStatsRuleContainer":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/InteractionStatsRule"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CallConversationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/CallConversation"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"PublishScriptRequestData":{"type":"object","properties":{"scriptId":{"type":"string"},"versionId":{"type":"string"}}},"RoutingData":{"type":"object","required":["queueId"],"properties":{"queueId":{"type":"string","description":"The identifier of the routing queue"},"languageId":{"type":"string","description":"The identifier of a language to be considered in routing"},"priority":{"type":"integer","format":"int32","description":"The priority for routing"},"skillIds":{"type":"array","description":"A list of skill identifiers to be considered in routing","items":{"type":"string"}},"preferredAgentIds":{"type":"array","description":"A list of agents to be preferred in routing","items":{"type":"string"}}}},"Bullseye":{"type":"object","properties":{"rings":{"type":"array","items":{"$ref":"#/definitions/Ring"}}}},"CallMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected on 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 this participant when disconnected on the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"purpose":{"type":"string","description":"The participant's purpose.  Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state.  Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","CONVERTING","UPLOADING","TRANSMITTING","NONE"]},"direction":{"type":"string","description":"The participant's direction.  Values can be: 'inbound' or 'outbound'","enum":["INBOUND","OUTBOUND"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold.","default":false},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up.","default":false},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/UriReference"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/UriReference"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorBody"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/UriReference"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up.","default":false},"muted":{"type":"boolean","description":"Value is true when the call is muted.","default":false},"confined":{"type":"boolean","description":"Value is true when the call is confined.","default":false},"recording":{"type":"boolean","description":"Value is true when the call is being recorded.","default":false},"recordingState":{"type":"string","description":"The state of the call recording.","enum":["NONE","ACTIVE","PAUSED"]},"group":{"description":"The group involved in the group ring call.","$ref":"#/definitions/UriReference"},"ani":{"type":"string","description":"The call ANI."},"dnis":{"type":"string","description":"The call DNIS."},"documentId":{"type":"string","description":"The ID of the Content Management document if the call is a fax."},"monitoredParticipantId":{"type":"string","description":"The ID of the participant being monitored when performing a call monitor."},"consultParticipantId":{"type":"string","description":"The ID of the consult transfer target participant when performing a consult transfer."}}},"CreateCallbackCommand":{"type":"object","required":["callbackNumbers"],"properties":{"scriptId":{"type":"string","description":"The identifier of the script to be used for the callback"},"queueId":{"type":"string","description":"The identifier of the queue to be used for the callback. Either queueId or routingData is required."},"routingData":{"description":"The routing data to be used for the callback. Either queueId or routingData is required.","$ref":"#/definitions/RoutingData"},"callbackUserName":{"type":"string","description":"The name of the party to be called back."},"callbackNumbers":{"type":"array","description":"A list of phone numbers for the callback.","items":{"type":"string"}},"callbackScheduledTime":{"type":"string","format":"date-time","example":"2015-01-02T16:59:59.000Z","description":"The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"countryCode":{"type":"string","description":"The country code to be associated with the callback numbers."},"skipEnabled":{"type":"boolean","description":"Indicates if the agent is allowed to skip the callback.","default":false},"data":{"type":"object","description":"A map of key-value pairs containing additional data that can be associated to the callback. These could be set up for instance to be used in a customized script shown during the call. Example: { \"notes\": \"ready to close the deal!\", \"customerPreferredName\": \"Doc\" }","additionalProperties":{"type":"string"}}}},"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"}}},"ScheduleInterval":{"type":"object","properties":{"start":{"type":"string","description":"scheduled start time represented as an ISO-8601 string; for example, yyyy-MM-ddTHH:mm:ss.SSSZ"},"end":{"type":"string","description":"scheduled end time represented as an ISO-8601 string; for example, yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"FlowHistoryDataItem":{"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"},"PhoneNumberStatus":{"type":"object","properties":{"callable":{"type":"boolean","description":"false if the phone number is not callable","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"},"type":{"type":"string"},"lineAppearanceId":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AggregationResult":{"type":"object","properties":{"type":{"type":"string","enum":["termFrequency","numericRange"]},"dimension":{"type":"string","description":"For termFrequency aggregations"},"metric":{"type":"string","description":"For numericRange aggregations"},"count":{"type":"integer","format":"int64"},"results":{"type":"array","items":{"$ref":"#/definitions/AggregationResultEntry"}}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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}}},"JsonNodeSearchResponse":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"previousPage":{"type":"string"},"currentPage":{"type":"string"},"nextPage":{"type":"string"},"types":{"type":"array","items":{"type":"string"}},"results":{"$ref":"#/definitions/JsonNode"},"aggregations":{"$ref":"#/definitions/JsonNode"}}},"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","inactive","deleted"]},"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/Contact"}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EstimatedWaitTimePredictions":{"type":"object","required":["results"],"properties":{"results":{"type":"array","description":"Returned upon a successful estimated wait time request.","items":{"$ref":"#/definitions/PredictionResults"}}}},"LocationsSearchResponse":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"previousPage":{"type":"string"},"currentPage":{"type":"string"},"nextPage":{"type":"string"},"types":{"type":"array","items":{"type":"string"}},"results":{"type":"array","items":{"$ref":"#/definitions/Location"}},"aggregations":{"type":"array","items":{"$ref":"#/definitions/Location"}}}},"DncList":{"type":"object","required":["phoneNumberColumns"],"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 time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"phoneNumberColumns":{"type":"array","description":"the name of the columns containing the numbers not to be called","items":{"type":"string"}},"importStatus":{"description":"the status of the import process","readOnly":true,"$ref":"#/definitions/ImportStatus"},"size":{"type":"integer","format":"int64","description":"the number of phone numbers in the do not call list","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateTemplateFromScriptRequestData":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"scriptId":{"type":"string"},"userId":{"type":"string"}}},"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}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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."},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Chat":{"type":"object","properties":{"jabberId":{"type":"string"}}},"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","US_TOLLFREE","XA_TOLLFREE","XB_TOLLFREE","XC_TOLLFREE","AG_DID","AI_DID","BB_DID","BM_DID","BS_DID","CA_DID","DM_DID","DO_DID","GD_DID","JM_DID","KN_DID","KY_DID","KZ_DID","LC_DID","MP_DID","MS_DID","RU_DID","TC_DID","TT_DID","US_DID","VC_DID","VG_DID","AF_DID","AR_DID","AT_DID","AU_DID","BE_DID","BR_DID","CH_DID","CL_DID","CN_DID","CO_DID","CU_DID","DE_DID","DK_DID","EG_DID","ES_DID","FR_DID","GB_DID","GR_DID","HU_DID","ID_DID","IN_DID","IR_DID","IT_DID","JP_DID","KR_DID","LK_DID","MM_DID","MX_DID","MY_DID","NL_DID","NO_DID","NZ_DID","PE_DID","PH_DID","PK_DID","PL_DID","RO_DID","SE_DID","SG_DID","TH_DID","TR_DID","VE_DID","VN_DID","ZA_DID","AD_DID","AE_DID","AL_DID","AM_DID","AO_DID","AQ_DID","AW_DID","AZ_DID","BA_DID","BD_DID","BF_DID","BG_DID","BH_DID","BI_DID","BJ_DID","BL_DID","BN_DID","BO_DID","BQ_DID","BT_DID","BW_DID","BY_DID","BZ_DID","CD_DID","CF_DID","CG_DID","CI_DID","CK_DID","CM_DID","CR_DID","CV_DID","CY_DID","CZ_DID","DJ_DID","DZ_DID","EC_DID","EE_DID","EH_DID","ER_DID","ET_DID","FI_DID","FJ_DID","FK_DID","FM_DID","FO_DID","GA_DID","GE_DID","GF_DID","GH_DID","GI_DID","GL_DID","GM_DID","GN_DID","GP_DID","GQ_DID","GT_DID","GW_DID","GY_DID","HK_DID","HN_DID","HR_DID","HT_DID","IE_DID","IL_DID","IO_DID","IQ_DID","IS_DID","JO_DID","KE_DID","KG_DID","KH_DID","KI_DID","KM_DID","KP_DID","KW_DID","LA_DID","LB_DID","LI_DID","LR_DID","LS_DID","LT_DID","LU_DID","LV_DID","LY_DID","MA_DID","MC_DID","MD_DID","ME_DID","MF_DID","MG_DID","MH_DID","MK_DID","ML_DID","MN_DID","MO_DID","MQ_DID","MR_DID","MT_DID","MU_DID","MV_DID","MW_DID","MZ_DID","NA_DID","NC_DID","NE_DID","NF_DID","NG_DID","NI_DID","NP_DID","NR_DID","NU_DID","OM_DID","PA_DID","PF_DID","PG_DID","PM_DID","PS_DID","PT_DID","PW_DID","PY_DID","QA_DID","RE_DID","RS_DID","RW_DID","SA_DID","SB_DID","SC_DID","SD_DID","SH_247_DID","SH_290_DID","SI_DID","SK_DID","SL_DID","SM_DID","SN_DID","SO_DID","SR_DID","SS_DID","ST_DID","SV_DID","SY_DID","SZ_DID","TD_DID","TG_DID","TJ_DID","TK_DID","TL_DID","TM_DID","TN_DID","TO_DID","TV_DID","TW_DID","TZ_DID","UA_DID","UG_DID","UY_DID","UZ_DID","VU_DID","WF_DID","WS_DID","XG_DID","XN_DID","XV_882_DID","XV_883_DID","YE_DID","YT_DID","ZM_DID","ZW_DID","SX_DID"]}}},"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/RoutingSkill"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ObservationQuery":{"type":"object","properties":{"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/AnalyticsQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *).","items":{"type":"string","enum":["tSegmentDuration","oTotalCriticalScore","oTotalScore","nEvaluations","tAbandon","tIvr","tAnswered","tAcd","tTalk","tHeld","tTalkComplete","tHeldComplete","tAcw","tHandle","tWait","tAgentRoutingStatus","tOrganizationPresence","tSystemPresence","tUserResponseTime","tAgentResponseTime","nOffered","nOverSla","nTransferred","nOutboundAttempted","nOutboundConnected","nOutboundAbandoned","nError","oServiceTarget","oServiceLevel","tActive","tInactive","oActiveUsers","oMemberUsers","oActiveQueues","oMemberQueues","oInteracting","oWaiting"]}}}},"ChatMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected on 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 this participant when disconnected on the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"purpose":{"type":"string","description":"The participant's purpose.  Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state.  Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","CONVERTING","UPLOADING","TRANSMITTING","NONE"]},"direction":{"type":"string","description":"The participant's direction.  Values can be: 'inbound' or 'outbound'","enum":["INBOUND","OUTBOUND"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold.","default":false},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up.","default":false},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/UriReference"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/UriReference"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorBody"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/UriReference"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up.","default":false},"roomId":{"type":"string","description":"The ID of the chat room."}}},"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."},"SharedEntity":{"type":"object","properties":{"id":{"type":"string"}}},"Keyword":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"phrase":{"type":"string"},"confidence":{"type":"integer","format":"int32"},"agentScoreModifier":{"type":"integer","format":"int32"},"customerScoreModifier":{"type":"integer","format":"int32"},"alternateSpellings":{"type":"array","items":{"type":"string"}}}},"CreateShareRequestMember":{"type":"object","properties":{"memberType":{"type":"string","enum":["USER","PUBLIC"]},"member":{"$ref":"#/definitions/MemberEntity"}}},"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/ContactAddress"},"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"},"externalDataSources":{"type":"array","description":"Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record.  Read-only, and only populated when requested via expand param.","readOnly":true,"items":{"$ref":"#/definitions/ExternalDataSource"}},"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."},"CreateUser":{"type":"object","required":["email","name","password"],"properties":{"name":{"type":"string","description":"User's full name"},"department":{"type":"string"},"email":{"type":"string","description":"User's email and username"},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"title":{"type":"string"},"password":{"type":"string","description":"User's password"}}},"RetentionDuration":{"type":"object","properties":{"archiveRetention":{"$ref":"#/definitions/ArchiveRetention"},"deleteRetention":{"$ref":"#/definitions/DeleteRetention"}}},"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","required":["columnName","type"],"properties":{"columnName":{"type":"string","description":"name of the phone column"},"type":{"type":"string","description":"type of the phone column, for example, 'cell' or 'home'"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeVersionInformation":{"type":"object","properties":{"softwareVersion":{"type":"string"}}},"AnalyticsEvaluation":{"type":"object","properties":{"evaluationId":{"type":"string"},"evaluatorId":{"type":"string"},"userId":{"type":"string"},"eventTime":{"type":"string"},"queueId":{"type":"string"},"formId":{"type":"string"},"contextId":{"type":"string"},"formName":{"type":"string"},"getoTotalScore":{"type":"integer","format":"int64"},"getoTotalCriticalScore":{"type":"integer","format":"int64"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","description":"The type of media that the recording is."},"annotations":{"type":"array","description":"Annotations that belong to the recording.","items":{"$ref":"#/definitions/Annotation"}},"transcript":{"type":"array","description":"Represents a chat transcript","items":{"$ref":"#/definitions/ChatMessage"}},"emailTranscript":{"type":"array","description":"Represents an email transcript","items":{"$ref":"#/definitions/RecordingEmailMessage"}},"fileState":{"type":"string","description":"Represents the current file state for a recording. Examples: Uploading, Archived, etc","enum":["ARCHIVED","AVAILABLE","DELETED","RESTORED","RESTORING","UPLOADING"]},"restoreExpirationTime":{"type":"string","format":"date-time","description":"The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"mediaUris":{"type":"object","description":"The different mediaUris for the recording.","additionalProperties":{"$ref":"#/definitions/MediaResult"}},"estimatedTranscodeTimeMs":{"type":"integer","format":"int64"},"actualTranscodeTimeMs":{"type":"integer","format":"int64"},"archiveDate":{"type":"string","format":"date-time","description":"The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"archiveMedium":{"type":"string","description":"The type of archive medium used. Example: CloudArchive","enum":["CLOUDARCHIVE"]},"deleteDate":{"type":"string","format":"date-time","description":"The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"maxAllowedRestorationsForOrg":{"type":"integer","format":"int32","description":"How many archive restorations the organization is allowed to have."},"remainingRestorationsAllowedForOrg":{"type":"integer","format":"int32","description":"The remaining archive restorations the organization has."},"sessionId":{"type":"string","description":"The session id represents an external resource id, such as email, call, chat, etc"},"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":{"$ref":"#/definitions/MediaSummaryDetail"},"enterprise":{"$ref":"#/definitions/MediaSummaryDetail"}}},"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}}},"AggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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/ContactAddress"},"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"},"externalDataSources":{"type":"array","description":"Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record.  Read-only, and only populated when requested via expand param.","readOnly":true,"items":{"$ref":"#/definitions/ExternalDataSource"}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GroupsSearchResponse":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"previousPage":{"type":"string"},"currentPage":{"type":"string"},"nextPage":{"type":"string"},"types":{"type":"array","items":{"type":"string"}},"results":{"type":"array","items":{"$ref":"#/definitions/Group"}},"aggregations":{"type":"array","items":{"$ref":"#/definitions/Group"}}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/VoicemailMessage"}},"selfUri":{"type":"string","format":"uri"}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GroupMembersUpdate":{"type":"object","properties":{"memberIds":{"type":"array","items":{"type":"string"}},"version":{"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}}},"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"},"pages":{"type":"array","items":{"$ref":"#/definitions/Page"}},"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}}},"AdditionalInfo":{"type":"object"},"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"}}},"GroupSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string"},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"returnFields":{"type":"array","items":{"type":"string"}},"expand":{"type":"array","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/GroupSearchCriteria"}}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"AnalyticsQueryAggregation":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["termFrequency","numericRange"]},"dimension":{"type":"string","description":"For use with termFrequency aggregations"},"metric":{"type":"string","description":"For use with numericRange aggregations"},"size":{"type":"integer","format":"int32","description":"For use with termFrequency aggregations"},"ranges":{"type":"array","description":"For use with numericRange aggregations","items":{"$ref":"#/definitions/AggregationRange"}}}},"CallableTime":{"type":"object","required":["timeZoneId"],"properties":{"timeSlots":{"type":"array","description":"intervals for which it is acceptable to place outbound calls","items":{"$ref":"#/definitions/CampaignTimeSlot"}},"timeZoneId":{"type":"string","example":"Africa/Abidjan","description":"time zone identifier to be applied to the time slots; for example Africa/Abidjan"}}},"ImportStatus":{"type":"object","required":["completedRecords","percentComplete","state","totalRecords"],"properties":{"state":{"type":"string","description":"current status of the import","readOnly":true,"enum":["IN_PROGRESS","FAILED"]},"totalRecords":{"type":"integer","format":"int64","description":"total number of records to be imported","readOnly":true},"completedRecords":{"type":"integer","format":"int64","description":"number of records finished importing","readOnly":true},"percentComplete":{"type":"integer","format":"int32","description":"percentage of records finished importing","readOnly":true},"failureReason":{"type":"string","description":"if the import has failed, the reason for the failure","readOnly":true}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"cardExpirationDate":{"type":"string","description":"for payment methods of type CARD_TOKEN, the card's expiration date in the format YYYY-MM."},"cardLastFourDigits":{"type":"string"},"cardType":{"type":"string","description":"for payment methods of type CARD_TOKEN, the type of credit or debit card","enum":["Visa","MasterCard","Discover","American Express"]},"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/BillingAddress"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateCallResponse":{"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}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"Auto populated from addresses.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"state":{"type":"string","description":"The current state for this user.","readOnly":true,"enum":["active","inactive","deleted"]},"title":{"type":"string"},"username":{"type":"string"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"Required when updating. Version must be the current version. Only the system can assign version.","readOnly":true},"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"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":{"description":"Information regarding the campaign's connect rate","readOnly":true,"$ref":"#/definitions/ConnectRate"},"idleAgents":{"type":"integer","format":"int32","description":"Number of available agents not currently being utilized","readOnly":true},"adjustedCallsPerAgent":{"type":"number","format":"double","description":"Calls per agent adjusted by pace","readOnly":true},"outstandingCalls":{"type":"integer","format":"int32","description":"Number of campaign calls currently ongoing","readOnly":true}}},"ObservationDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/AggregateMetricData"}}}},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RecordingEmailMessage":{"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"}}},"DomainRole":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the role"},"name":{"type":"string","description":"The name of the role"}}},"DisconnectReason":{"type":"object","properties":{"type":{"type":"string","enum":["Q_850","SIP"]},"code":{"type":"integer","format":"int32"},"phrase":{"type":"string"}}},"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}}},"AggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/AggregateDataContainer"}}}},"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"},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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}}},"VideoMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected on 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 this participant when disconnected on the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"purpose":{"type":"string","description":"The participant's purpose.  Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state.  Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","CONVERTING","UPLOADING","TRANSMITTING","NONE"]},"direction":{"type":"string","description":"The participant's direction.  Values can be: 'inbound' or 'outbound'","enum":["INBOUND","OUTBOUND"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold.","default":false},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up.","default":false},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/UriReference"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/UriReference"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorBody"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/UriReference"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up.","default":false},"audioMuted":{"type":"boolean","description":"Value is true when audio is muted.","default":false},"videoMuted":{"type":"boolean","description":"Value is true when video is muted.","default":false},"sharingScreen":{"type":"boolean","description":"Value is true when screen sharing is enabled.","default":false},"peerCount":{"type":"integer","format":"int32","description":"The number of peers of this participant."},"context":{"type":"string","description":"The context for this participant."}}},"NumberOrder":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"did":{"type":"string","description":"DID purchased"},"effectiveStartDate":{"type":"string","format":"date-time","description":"Effective date of service for this order. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"effectiveEndDate":{"type":"string","format":"date-time","description":"Effective disconnection date for this order. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"lastUpdated":{"type":"string","format":"date-time","description":"Date of last update. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"startAuthUserId":{"type":"string","description":"UserId authorizing purchase"},"endAuthUserId":{"type":"string","description":"UserId authorizing disconnection"},"status":{"type":"string","description":"Current status of this DID order","enum":["COMPLETE","CONNECTING","FAILED","BACKORDERED","PENDING","ACTIVATING","ACTIVATION_ERROR","ERROR","DISCONNECTED","DISCONNECT_PENDING","DEACTIVATING","DEACTIVATION_ERROR","DISCONNECT_FAILED","SUBMITTED","REJECTED","SUPP","PORT_PENDING","FOC"]},"phoneNumberType":{"type":"string","description":"Class of DID being purchased (eg. us-domestic, toll-free, etc)","enum":["TOLL_FREE","CN_DOMESTIC","US_DOMESTIC","US_TOLLFREE","XA_TOLLFREE","XB_TOLLFREE","XC_TOLLFREE","AG_DID","AI_DID","BB_DID","BM_DID","BS_DID","CA_DID","DM_DID","DO_DID","GD_DID","JM_DID","KN_DID","KY_DID","KZ_DID","LC_DID","MP_DID","MS_DID","RU_DID","TC_DID","TT_DID","US_DID","VC_DID","VG_DID","AF_DID","AR_DID","AT_DID","AU_DID","BE_DID","BR_DID","CH_DID","CL_DID","CN_DID","CO_DID","CU_DID","DE_DID","DK_DID","EG_DID","ES_DID","FR_DID","GB_DID","GR_DID","HU_DID","ID_DID","IN_DID","IR_DID","IT_DID","JP_DID","KR_DID","LK_DID","MM_DID","MX_DID","MY_DID","NL_DID","NO_DID","NZ_DID","PE_DID","PH_DID","PK_DID","PL_DID","RO_DID","SE_DID","SG_DID","TH_DID","TR_DID","VE_DID","VN_DID","ZA_DID","AD_DID","AE_DID","AL_DID","AM_DID","AO_DID","AQ_DID","AW_DID","AZ_DID","BA_DID","BD_DID","BF_DID","BG_DID","BH_DID","BI_DID","BJ_DID","BL_DID","BN_DID","BO_DID","BQ_DID","BT_DID","BW_DID","BY_DID","BZ_DID","CD_DID","CF_DID","CG_DID","CI_DID","CK_DID","CM_DID","CR_DID","CV_DID","CY_DID","CZ_DID","DJ_DID","DZ_DID","EC_DID","EE_DID","EH_DID","ER_DID","ET_DID","FI_DID","FJ_DID","FK_DID","FM_DID","FO_DID","GA_DID","GE_DID","GF_DID","GH_DID","GI_DID","GL_DID","GM_DID","GN_DID","GP_DID","GQ_DID","GT_DID","GW_DID","GY_DID","HK_DID","HN_DID","HR_DID","HT_DID","IE_DID","IL_DID","IO_DID","IQ_DID","IS_DID","JO_DID","KE_DID","KG_DID","KH_DID","KI_DID","KM_DID","KP_DID","KW_DID","LA_DID","LB_DID","LI_DID","LR_DID","LS_DID","LT_DID","LU_DID","LV_DID","LY_DID","MA_DID","MC_DID","MD_DID","ME_DID","MF_DID","MG_DID","MH_DID","MK_DID","ML_DID","MN_DID","MO_DID","MQ_DID","MR_DID","MT_DID","MU_DID","MV_DID","MW_DID","MZ_DID","NA_DID","NC_DID","NE_DID","NF_DID","NG_DID","NI_DID","NP_DID","NR_DID","NU_DID","OM_DID","PA_DID","PF_DID","PG_DID","PM_DID","PS_DID","PT_DID","PW_DID","PY_DID","QA_DID","RE_DID","RS_DID","RW_DID","SA_DID","SB_DID","SC_DID","SD_DID","SH_247_DID","SH_290_DID","SI_DID","SK_DID","SL_DID","SM_DID","SN_DID","SO_DID","SR_DID","SS_DID","ST_DID","SV_DID","SY_DID","SZ_DID","TD_DID","TG_DID","TJ_DID","TK_DID","TL_DID","TM_DID","TN_DID","TO_DID","TV_DID","TW_DID","TZ_DID","UA_DID","UG_DID","UY_DID","UZ_DID","VU_DID","WF_DID","WS_DID","XG_DID","XN_DID","XV_882_DID","XV_883_DID","YE_DID","YT_DID","ZM_DID","ZW_DID","SX_DID"]},"porting":{"type":"boolean","description":"Whether or not the number was ported","default":false},"billingAddress":{"description":"Billing address used for a number port","$ref":"#/definitions/PortBillingAddress"},"responsibleContact":{"description":"Company contact for a number port","$ref":"#/definitions/PortContact"},"companyName":{"type":"string","description":"Company name for a number port"},"countryCode":{"type":"string","description":"Country dial in codes (telephone dialing prefixes)"},"envelopeId":{"type":"string","description":"Id of the terms and conditions envelope for the order."},"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}}},"Change":{"type":"object","properties":{"entity":{"$ref":"#/definitions/AuditEntity"},"property":{"type":"string"},"oldValues":{"type":"array","items":{"type":"string"}},"newValues":{"type":"array","items":{"type":"string"}}}},"IntegrationStatusInfo":{"type":"object","properties":{"internal":{"type":"string","description":"Machine-readable status as reported by the integration.","readOnly":true,"enum":["ACTIVE","ACTIVATING","INACTIVE","DEACTIVATING","ERROR"]},"effective":{"type":"string","description":"Localized, human-readable, effective status of the integration.","readOnly":true},"detail":{"type":"string","description":"Localized status details for the integration.","readOnly":true},"lastUpdated":{"type":"string","format":"date-time","description":"Date and time (in UTC) when the integration status (i.e. the internal field) was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true}},"description":"Status information for an Integration."},"Contact":{"type":"object","properties":{"address":{"type":"string","description":"Email address or phone number for this contact type"},"display":{"type":"string","description":"Formatted version of the address property","readOnly":true},"mediaType":{"type":"string","enum":["PHONE","EMAIL","SMS"]},"type":{"type":"string","enum":["PRIMARY","WORK","WORK2","WORK3","WORK4","HOME","MOBILE","MAIN"]}}},"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"},"interactionType":{"type":"string","description":"The interaction type for this response.","enum":["chat","email","twitter"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Contains information about a response."},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"disabled":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserRoutingSkill":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"proficiency":{"type":"number","format":"double","description":"Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular skill. It is used when a queue is set to \"Best available skills\" mode to allow acd interactions to target agents with higher proficiency ratings."},"state":{"type":"string","description":"Activate or deactivate this routing skill.","enum":["active","inactive","deleted"]},"skillUri":{"type":"string","format":"uri","description":"URI to the organization skill used by this user skill.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id."},"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"},"lastUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AuthzSubject":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"grants":{"type":"array","items":{"$ref":"#/definitions/AuthzGrant"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PortContact":{"type":"object","properties":{"email":{"type":"string"},"phoneNumber":{"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"}}},"externalDocs":{"description":"PureCloud API Documentation","url":"https://developer.mypurecloud.com"}}
+{"swagger":"2.0","info":{"description":"With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.","version":"v2","title":"PureCloud Platform API","termsOfService":"https://developer.mypurecloud.com/tos","contact":{"name":"PureCloud Developer Evangelists","url":"https://developer.mypurecloud.com","email":"[e-mail]"},"license":{"name":"ININ","url":"http://www.inin.com"}},"host":"api.mypurecloud.com","tags":[{"name":"Alerting","description":"Rules and alerts"},{"name":"Analytics","description":"Analytics querying and reporting.","externalDocs":{"description":"analytics docs","url":"https://developer.mypurecloud.com/analytics"}},{"name":"Attributes","description":"Attribute definitions"},{"name":"Authorization","description":"Roles and permissions","externalDocs":{"description":"authorization docs","url":"https://developer.mypurecloud.com/authorization"}},{"name":"Configuration","description":""},{"name":"Content Management","description":""},{"name":"Conversations","description":""},{"name":"Calls","description":""},{"name":"Callbacks","description":""},{"name":"Chats","description":""},{"name":"Emails","description":""},{"name":"Faxes","description":""},{"name":"Socials","description":""},{"name":"Videos","description":""},{"name":"Directory Proxy","description":"Search, Suggest, and people"},{"name":"Docs","description":"Swagger documentation definitions","externalDocs":{"description":"docs","url":"https://developer.mypurecloud.com"}},{"name":"Fax","description":""},{"name":"Geolocation","description":""},{"name":"Greetings","description":""},{"name":"Groups","description":"Groups, members"},{"name":"Identity Provider","description":"Identity providers"},{"name":"Languages","description":"Available languages"},{"name":"Locations","description":"Physical locations"},{"name":"Notifications","description":"Channels, subscriptions, topics"},{"name":"OAuth","description":"OAuth clients, providers"},{"name":"Organization","description":"Organization"},{"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":"Search","description":"Search aggregate, users, groups"},{"name":"Suggest","description":"Search suggest user, group, locations"},{"name":"Sessions","description":"User session"},{"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/v2/alerting/interactionstats/alerts":{"get":{"tags":["Alerting"],"summary":"Get interaction stats alert list.","description":"","operationId":"getInteractionstatsAlerts","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsAlertContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getInteractionstatsAlerts"}},"/api/v2/alerting/interactionstats/alerts/unread":{"get":{"tags":["Alerting"],"summary":"Gets user unread count of interaction stats alerts.","description":"","operationId":"getInteractionstatsAlertsUnread","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnreadMetric"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getInteractionstatsAlertsUnread"}},"/api/v2/alerting/interactionstats/alerts/{alertId}":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats alert","description":"","operationId":"getInteractionstatsAlertsAlertId","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsAlert"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getInteractionstatsAlertsAlertId"},"put":{"tags":["Alerting"],"summary":"Update an interaction stats alert read status","description":"","operationId":"putInteractionstatsAlertsAlertId","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"},{"in":"body","name":"body","description":"InteractionStatsAlert","required":false,"schema":{"$ref":"#/definitions/UnreadStatus"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnreadStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putInteractionstatsAlertsAlertId"},"delete":{"tags":["Alerting"],"summary":"Delete an interaction stats alert","description":"","operationId":"deleteInteractionstatsAlertsAlertId","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert 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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteInteractionstatsAlertsAlertId"}},"/api/v2/alerting/interactionstats/rules":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats rule list.","description":"","operationId":"getInteractionstatsRules","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRuleContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getInteractionstatsRules"},"post":{"tags":["Alerting"],"summary":"Create an interaction stats rule.","description":"","operationId":"postInteractionstatsRules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"AlertingRule","required":false,"schema":{"$ref":"#/definitions/InteractionStatsRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postInteractionstatsRules"}},"/api/v2/alerting/interactionstats/rules/{ruleId}":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats rule.","description":"","operationId":"getInteractionstatsRulesRuleId","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getInteractionstatsRulesRuleId"},"put":{"tags":["Alerting"],"summary":"Update an interaction stats rule","description":"","operationId":"putInteractionstatsRulesRuleId","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule ID","required":true,"type":"string"},{"in":"body","name":"body","description":"AlertingRule","required":false,"schema":{"$ref":"#/definitions/InteractionStatsRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putInteractionstatsRulesRuleId"},"delete":{"tags":["Alerting"],"summary":"Delete an interaction stats rule.","description":"","operationId":"deleteInteractionstatsRulesRuleId","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule 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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteInteractionstatsRulesRuleId"}},"/api/v2/analytics/conversations/aggregates/query":{"post":{"tags":["Conversations","Analytics"],"summary":"Query for conversation aggregates","description":"","operationId":"postConversationsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":false,"schema":{"$ref":"#/definitions/AggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required.field.missing":"A required field is missing a value."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationsAggregatesQuery"}},"/api/v2/analytics/conversations/details/query":{"post":{"tags":["Conversations","Analytics"],"summary":"Query for conversation details","description":"","operationId":"postConversationsDetailsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":false,"schema":{"$ref":"#/definitions/ConversationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationsDetailsQuery"}},"/api/v2/analytics/conversations/{conversationId}/details":{"get":{"tags":["Conversations","Analytics"],"summary":"Get a conversation by id","description":"","operationId":"getConversationsConversationIdDetails","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationsConversationIdDetails"}},"/api/v2/analytics/conversations/{conversationId}/details/properties":{"post":{"tags":["Conversations","Analytics"],"summary":"Index conversation properties","description":"","operationId":"postConversationsConversationIdDetailsProperties","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"request","required":false,"schema":{"$ref":"#/definitions/PropertyIndexRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PropertyIndexRequest"}},"202":{"description":"Accepted - Indexing properties"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationsConversationIdDetailsProperties"}},"/api/v2/analytics/evaluations/aggregates/query":{"post":{"tags":["Quality","Analytics"],"summary":"Query for evaluation aggregates","description":"","operationId":"postEvaluationsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":false,"schema":{"$ref":"#/definitions/AggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEvaluationsAggregatesQuery"}},"/api/v2/analytics/queues/observations/query":{"post":{"tags":["Routing","Analytics"],"summary":"Query for queue observations","description":"","operationId":"postQueuesObservationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":false,"schema":{"$ref":"#/definitions/ObservationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ObservationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQueuesObservationsQuery"}},"/api/v2/analytics/reporting/metadata":{"get":{"tags":["Analytics"],"summary":"Get list of reporting metadata.","description":"","operationId":"getReportingMetadata","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":"locale","in":"query","description":"Locale","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportMetaDataEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getReportingMetadata"}},"/api/v2/analytics/reporting/reportformats":{"get":{"tags":["Analytics"],"summary":"Get a list of report formats","description":"Get a list of report formats.","operationId":"getReportingReportformats","produces":["application/json"],"parameters":[],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getReportingReportformats"}},"/api/v2/analytics/reporting/schedules":{"get":{"tags":["Analytics"],"summary":"Get a list of scheduled report jobs","description":"Get a list of scheduled report jobs.","operationId":"getReportingSchedules","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/ReportScheduleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getReportingSchedules"},"post":{"tags":["Analytics"],"summary":"Create a scheduled report job","description":"Create a scheduled report job.","operationId":"postReportingSchedules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ReportSchedule","required":false,"schema":{"$ref":"#/definitions/ReportSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postReportingSchedules"}},"/api/v2/analytics/reporting/schedules/{scheduleId}":{"get":{"tags":["Analytics"],"summary":"Get a scheduled report job.","description":"","operationId":"getReportingSchedulesScheduleId","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getReportingSchedulesScheduleId"},"put":{"tags":["Analytics"],"summary":"Update a scheduled report job.","description":"","operationId":"putReportingSchedulesScheduleId","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ReportSchedule","required":false,"schema":{"$ref":"#/definitions/ReportSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putReportingSchedulesScheduleId"},"delete":{"tags":["Analytics"],"summary":"Delete a scheduled report job.","description":"","operationId":"deleteReportingSchedulesScheduleId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteReportingSchedulesScheduleId"}},"/api/v2/analytics/reporting/schedules/{scheduleId}/history":{"get":{"tags":["Analytics"],"summary":"Get list of completed scheduled report jobs.","description":"","operationId":"getReportingSchedulesScheduleIdHistory","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportRunEntryEntityDomainListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getReportingSchedulesScheduleIdHistory"}},"/api/v2/analytics/reporting/schedules/{scheduleId}/history/latest":{"get":{"tags":["Analytics"],"summary":"Get most recently completed scheduled report job.","description":"","operationId":"getReportingSchedulesScheduleIdHistoryLatest","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportRunEntry"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getReportingSchedulesScheduleIdHistoryLatest"}},"/api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId}":{"get":{"tags":["Analytics"],"summary":"A completed scheduled report job","description":"A completed scheduled report job.","operationId":"getReportingSchedulesScheduleIdHistoryRunId","produces":["application/json"],"parameters":[{"name":"runId","in":"path","description":"Run ID","required":true,"type":"string"},{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportRunEntry"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getReportingSchedulesScheduleIdHistoryRunId"}},"/api/v2/analytics/reporting/schedules/{scheduleId}/runreport":{"post":{"tags":["Analytics"],"summary":"Place a scheduled report immediately into the reporting queue","description":"","operationId":"postReportingSchedulesScheduleIdRunreport","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RunNowResponse"}},"202":{"description":"Accepted - Processing Report"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postReportingSchedulesScheduleIdRunreport"}},"/api/v2/analytics/reporting/timeperiods":{"get":{"tags":["Analytics"],"summary":"Get a list of report time periods.","description":"","operationId":"getReportingTimeperiods","produces":["application/json"],"parameters":[],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getReportingTimeperiods"}},"/api/v2/analytics/reporting/{reportId}/metadata":{"get":{"tags":["Analytics"],"summary":"Get a reporting metadata.","description":"","operationId":"getReportingReportIdMetadata","produces":["application/json"],"parameters":[{"name":"reportId","in":"path","description":"Report ID","required":true,"type":"string"},{"name":"locale","in":"query","description":"Locale","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportMetaData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getReportingReportIdMetadata"}},"/api/v2/analytics/users/aggregates/query":{"post":{"tags":["Users","Analytics"],"summary":"Query for user aggregates","description":"","operationId":"postUsersAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":false,"schema":{"$ref":"#/definitions/AggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PresenceQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postUsersAggregatesQuery"}},"/api/v2/analytics/users/observations/query":{"post":{"tags":["Users","Analytics"],"summary":"Query for user observations","description":"","operationId":"postUsersObservationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":false,"schema":{"$ref":"#/definitions/ObservationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ObservationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postUsersObservationsQuery"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postAttributes"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQuery"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"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"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteAttributeId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPermissions"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProducts"}},"/api/v2/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":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRoles"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRolesDefault"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRolesLeftroleIdComparedefaultRightroleId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchRolesRoleId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRolesRoleIdUsersAdd"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRolesRoleIdUsersRemove"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDetails"}},"/api/v2/configuration/schemas/edges/vnext":{"get":{"tags":["Telephony Providers Edge"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchemasEdgesVnext"}},"/api/v2/configuration/schemas/edges/vnext/{schemaCategory}":{"get":{"tags":["Telephony Providers Edge"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchemasEdgesVnextSchemacategory"}},"/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}":{"get":{"tags":["Telephony Providers Edge"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchemasEdgesVnextSchemacategorySchematype"}},"/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}":{"get":{"tags":["Telephony Providers Edge"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchemasEdgesVnextSchemacategorySchematypeSchemaId"}},"/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}/{extensionType}/{metadataId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get metadata for a schema","description":"","operationId":"getSchemasEdgesVnextSchemacategorySchematypeSchemaIdExtensiontypeMetadataId","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":"extensionType","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchemasEdgesVnextSchemacategorySchematypeSchemaIdExtensiontypeMetadataId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postAuditquery"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The source document is locked by another operation"},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDocuments"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"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"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteDocumentsDocumentId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDocumentsDocumentIdAudits"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"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"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDocumentsDocumentIdContent"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQuery"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSecurityprofiles"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSecurityprofilesSecurityprofileId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSharedSharedId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postShares"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSharesShareId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getStatus"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteStatusStatusId"}},"/api/v2/contentmanagement/usage":{"get":{"tags":["Content Management"],"summary":"Get usage details.","description":"","operationId":"getUsage","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Usage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUsage"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postWorkspaces"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteWorkspacesWorkspaceId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getWorkspacesWorkspaceIdMembers"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteWorkspacesWorkspaceIdMembersMemberId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postWorkspacesWorkspaceIdTagvalues"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postWorkspacesWorkspaceIdTagvaluesQuery"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteWorkspacesWorkspaceIdTagvaluesTagId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversations"}},"/api/v2/conversations/callbacks":{"get":{"tags":["Conversations"],"summary":"Get callback conversations","description":"","operationId":"getCallbacks","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallbackConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallbacks"},"post":{"tags":["Conversations"],"summary":"Create a Callback","description":"","operationId":"postCallbacks","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateCallbackCommand"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateCallbackResponse"}},"202":{"description":"Accepted - Creating and Processing a Callback"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallbacks"}},"/api/v2/conversations/callbacks/{callbackId}":{"get":{"tags":["Conversations"],"summary":"Get callback conversation","description":"","operationId":"getCallbacksCallbackId","produces":["application/json"],"parameters":[{"name":"callbackId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallbackConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallbacksCallbackId"}},"/api/v2/conversations/callbacks/{callbackId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchCallbacksCallbackIdParticipantsParticipantId","produces":["application/json"],"parameters":[{"name":"callbackId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchCallbacksCallbackIdParticipantsParticipantId"}},"/api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchCallbacksCallbackIdParticipantsParticipantIdAttributes","produces":["application/json"],"parameters":[{"name":"callbackId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchCallbacksCallbackIdParticipantsParticipantIdAttributes"}},"/api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postCallbacksCallbackIdParticipantsParticipantIdReplace","produces":["application/json"],"parameters":[{"name":"callbackId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallbacksCallbackIdParticipantsParticipantIdReplace"}},"/api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getCallbacksCallbackIdParticipantsParticipantIdWrapup","produces":["application/json"],"parameters":[{"name":"callbackId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallbacksCallbackIdParticipantsParticipantIdWrapup"}},"/api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getCallbacksCallbackIdParticipantsParticipantIdWrapupcodes","produces":["application/json"],"parameters":[{"name":"callbackId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallbacksCallbackIdParticipantsParticipantIdWrapupcodes"}},"/api/v2/conversations/calls":{"get":{"tags":["Conversations"],"summary":"Get recent conversations","description":"","operationId":"getCalls","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCalls"},"post":{"tags":["Conversations"],"summary":"Create a call conversation","description":"","operationId":"postCalls","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateCallRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateCallResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","conversation.error.no.user.station":"A station is required to place a call.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCalls"}},"/api/v2/conversations/calls/history":{"get":{"tags":["Conversations"],"summary":"Get call history","description":"","operationId":"getCallsHistory","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":"interval","in":"query","description":"Interval string; format is ISO-8601. Separate start and end times with forward slash '/'","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallsHistory"}},"/api/v2/conversations/calls/maximumconferenceparties":{"get":{"tags":["Conversations"],"summary":"Get the maximum number of participants that this user can have on a conference","description":"","operationId":"getCallsMaximumconferenceparties","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallsMaximumconferenceparties"}},"/api/v2/conversations/calls/{callId}":{"get":{"tags":["Conversations"],"summary":"Get call conversation","description":"","operationId":"getCallsCallId","produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallsCallId"},"post":{"tags":["Conversations"],"summary":"Add a new call to a conversation","description":"","operationId":"postCallsCallId","produces":["application/json"],"parameters":[{"name":"callId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallsCallId"},"patch":{"tags":["Conversations"],"summary":"Update conversation","description":"","operationId":"patchCallsCallId","produces":["application/json"],"parameters":[{"name":"callId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchCallsCallId"}},"/api/v2/conversations/calls/{callId}/participants":{"post":{"tags":["Conversations"],"summary":"Add participants to a conversation","description":"","operationId":"postCallsCallIdParticipants","produces":["application/json"],"parameters":[{"name":"callId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallsCallIdParticipants"}},"/api/v2/conversations/calls/{callId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchCallsCallIdParticipantsParticipantId","produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchCallsCallIdParticipantsParticipantId"}},"/api/v2/conversations/calls/{callId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchCallsCallIdParticipantsParticipantIdAttributes","produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchCallsCallIdParticipantsParticipantIdAttributes"}},"/api/v2/conversations/calls/{callId}/participants/{participantId}/consult":{"post":{"tags":["Conversations"],"summary":"Initiate and update consult transfer","description":"","operationId":"postCallsCallIdParticipantsParticipantIdConsult","produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallsCallIdParticipantsParticipantIdConsult"},"delete":{"tags":["Conversations"],"summary":"Cancel the transfer","description":"","operationId":"deleteCallsCallIdParticipantsParticipantIdConsult","produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCallsCallIdParticipantsParticipantIdConsult"},"patch":{"tags":["Conversations"],"summary":"Change who can speak","description":"","operationId":"patchCallsCallIdParticipantsParticipantIdConsult","produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchCallsCallIdParticipantsParticipantIdConsult"}},"/api/v2/conversations/calls/{callId}/participants/{participantId}/monitor":{"post":{"tags":["Conversations"],"summary":"Listen in on the conversation from the point of view of a given participant.","description":"","operationId":"postCallsCallIdParticipantsParticipantIdMonitor","produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","conversation.error.monitor.own.conversation":"A user cannot monitor a conversation where they are an active participant.","conversation.error.no.user.station":"A station is required to place a call.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallsCallIdParticipantsParticipantIdMonitor"}},"/api/v2/conversations/calls/{callId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postCallsCallIdParticipantsParticipantIdReplace","produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallsCallIdParticipantsParticipantIdReplace"}},"/api/v2/conversations/calls/{callId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getCallsCallIdParticipantsParticipantIdWrapup","produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallsCallIdParticipantsParticipantIdWrapup"}},"/api/v2/conversations/calls/{callId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getCallsCallIdParticipantsParticipantIdWrapupcodes","produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCallsCallIdParticipantsParticipantIdWrapupcodes"}},"/api/v2/conversations/chats":{"get":{"tags":["Conversations"],"summary":"Get recent chat conversations","description":"","operationId":"getChats","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getChats"}},"/api/v2/conversations/chats/{chatId}":{"get":{"tags":["Conversations"],"summary":"Get chat conversation","description":"","operationId":"getChatsChatId","produces":["application/json"],"parameters":[{"name":"chatId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getChatsChatId"}},"/api/v2/conversations/chats/{chatId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchChatsChatIdParticipantsParticipantId","produces":["application/json"],"parameters":[{"name":"chatId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchChatsChatIdParticipantsParticipantId"}},"/api/v2/conversations/chats/{chatId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchChatsChatIdParticipantsParticipantIdAttributes","produces":["application/json"],"parameters":[{"name":"chatId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchChatsChatIdParticipantsParticipantIdAttributes"}},"/api/v2/conversations/chats/{chatId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postChatsChatIdParticipantsParticipantIdReplace","produces":["application/json"],"parameters":[{"name":"chatId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postChatsChatIdParticipantsParticipantIdReplace"}},"/api/v2/conversations/chats/{chatId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getChatsChatIdParticipantsParticipantIdWrapup","produces":["application/json"],"parameters":[{"name":"chatId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getChatsChatIdParticipantsParticipantIdWrapup"}},"/api/v2/conversations/chats/{chatId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getChatsChatIdParticipantsParticipantIdWrapupcodes","produces":["application/json"],"parameters":[{"name":"chatId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getChatsChatIdParticipantsParticipantIdWrapupcodes"}},"/api/v2/conversations/emails":{"get":{"tags":["Conversations"],"summary":"Get recent email conversations","description":"","operationId":"getEmails","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmails"}},"/api/v2/conversations/emails/{emailId}":{"get":{"tags":["Conversations"],"summary":"Get email conversation","description":"","operationId":"getEmailsEmailId","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailsEmailId"}},"/api/v2/conversations/emails/{emailId}/messages":{"get":{"tags":["Conversations"],"summary":"Get conversation messages","description":"","operationId":"getEmailsEmailIdMessages","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailsEmailIdMessages"},"post":{"tags":["Conversations"],"summary":"Send an email reply","description":"","operationId":"postEmailsEmailIdMessages","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEmailsEmailIdMessages"}},"/api/v2/conversations/emails/{emailId}/messages/draft":{"get":{"tags":["Conversations"],"summary":"Get conversation draft reply","description":"","operationId":"getEmailsEmailIdMessagesDraft","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailsEmailIdMessagesDraft"},"put":{"tags":["Conversations"],"summary":"Update conversation draft reply","description":"","operationId":"putEmailsEmailIdMessagesDraft","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putEmailsEmailIdMessagesDraft"}},"/api/v2/conversations/emails/{emailId}/messages/draft/attachments/{attachmentId}":{"delete":{"tags":["Conversations"],"summary":"Delete attachment from draft","description":"","operationId":"deleteEmailsEmailIdMessagesDraftAttachmentsAttachmentId","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","required":true,"type":"string"},{"name":"attachmentId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteEmailsEmailIdMessagesDraftAttachmentsAttachmentId"}},"/api/v2/conversations/emails/{emailId}/messages/{messageId}":{"get":{"tags":["Conversations"],"summary":"Get conversation message","description":"","operationId":"getEmailsEmailIdMessagesMessageId","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","required":true,"type":"string"},{"name":"messageId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailsEmailIdMessagesMessageId"}},"/api/v2/conversations/emails/{emailId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchEmailsEmailIdParticipantsParticipantId","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchEmailsEmailIdParticipantsParticipantId"}},"/api/v2/conversations/emails/{emailId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchEmailsEmailIdParticipantsParticipantIdAttributes","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchEmailsEmailIdParticipantsParticipantIdAttributes"}},"/api/v2/conversations/emails/{emailId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postEmailsEmailIdParticipantsParticipantIdReplace","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEmailsEmailIdParticipantsParticipantIdReplace"}},"/api/v2/conversations/emails/{emailId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getEmailsEmailIdParticipantsParticipantIdWrapup","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailsEmailIdParticipantsParticipantIdWrapup"}},"/api/v2/conversations/emails/{emailId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getEmailsEmailIdParticipantsParticipantIdWrapupcodes","produces":["application/json"],"parameters":[{"name":"emailId","in":"path","required":true,"type":"string"},{"name":"participantId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailsEmailIdParticipantsParticipantIdWrapupcodes"}},"/api/v2/conversations/faxes":{"post":{"tags":["Conversations"],"summary":"Create Fax Conversation","description":"","operationId":"postFaxes","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","fax.content.type.not.supported":"The fax content type is not supported.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"fax.forbidden":"You are not permitted to send faxes.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postFaxes"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationId"}},"/api/v2/conversations/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update a participant.","description":"Update conversation participant.","operationId":"patchConversationIdParticipantsParticipantId","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/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchConversationIdParticipantsParticipantId"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationIdParticipantsParticipantIdAttributes","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchConversationIdParticipantsParticipantIdAttributes"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdParticipantsParticipantIdCallbacks"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode}":{"delete":{"tags":["Conversations"],"summary":"Delete a code used to add a communication to this participant","description":"","operationId":"deleteConversationIdParticipantsParticipantIdCodesAddcommunicationcode","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":"addCommunicationCode","in":"path","description":"addCommunicationCode","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteConversationIdParticipantsParticipantIdCodesAddcommunicationcode"}},"/api/v2/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"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdParticipantsParticipantIdReplace"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdParticipantsParticipantIdWrapup"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdParticipantsParticipantIdWrapupcodes"}},"/api/v2/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 media format","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","NONE"]}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationIdRecordings"}},"/api/v2/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":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","NONE"]},{"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"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"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putConversationIdRecordingsRecordingId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationIdRecordingsRecordingIdAnnotations"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteConversationIdRecordingsRecordingIdAnnotationsAnnotationId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDate"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDocuments"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteDocumentsDocumentId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDocumentsDocumentIdContent"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSummary"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchSettings"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postGreetings"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putDefaults"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteGreetingId"}},"/api/v2/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 media format.","required":false,"type":"string","default":"WAV","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","NONE"]}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getGreetingIdMedia"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getGroups"},"post":{"tags":["Groups"],"summary":"Create a group","description":"","operationId":"postGroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Group"}}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postGroups"}},"/api/v2/groups/search":{"get":{"tags":["Groups","Search"],"summary":"Search using q64","description":"","operationId":"getSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","required":false,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSearch"},"post":{"tags":["Groups","Search"],"summary":"Search","description":"","operationId":"postSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":false,"schema":{"$ref":"#/definitions/GroupSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSearch"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getGroupId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getGroupIdMembers"},"post":{"tags":["Groups"],"summary":"Add members","description":"","operationId":"postGroupIdMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Add members","required":false,"schema":{"$ref":"#/definitions/GroupMembersUpdate"}}],"responses":{"202":{"description":"Success, group membership was updated"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postGroupIdMembers"},"delete":{"tags":["Groups"],"summary":"Remove members","description":"","operationId":"deleteGroupIdMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"ids","in":"query","description":"Comma separated list of userIds to remove","required":true,"type":"string"}],"responses":{"202":{"description":"Success, group membership was updated"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteGroupIdMembers"}},"/api/v2/identityproviders":{"get":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getIdentityproviders"}},"/api/v2/identityproviders/adfs":{"get":{"tags":["Identity Provider"],"summary":"Get ADFS Identity Provider","description":"","operationId":"getAdfs","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ADFS"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getAdfs"},"put":{"tags":["Identity Provider"],"summary":"Update/Create ADFS Identity Provider","description":"","operationId":"putAdfs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":false,"schema":{"$ref":"#/definitions/ADFS"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putAdfs"},"delete":{"tags":["Identity Provider"],"summary":"Delete ADFS Identity Provider","description":"","operationId":"deleteAdfs","produces":["application/json"],"parameters":[],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteAdfs"}},"/api/v2/identityproviders/cic":{"get":{"tags":["Identity Provider"],"summary":"Get Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"getCic","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CustomerInteractionCenter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCic"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"putCic","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":false,"schema":{"$ref":"#/definitions/CustomerInteractionCenter"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putCic"},"delete":{"tags":["Identity Provider"],"summary":"Delete Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"deleteCic","produces":["application/json"],"parameters":[],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCic"}},"/api/v2/identityproviders/okta":{"get":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOkta"},"put":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putOkta"},"delete":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteOkta"}},"/api/v2/identityproviders/onelogin":{"get":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOnelogin"},"put":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putOnelogin"},"delete":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteOnelogin"}},"/api/v2/identityproviders/purecloud":{"get":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPurecloud"},"put":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putPurecloud"},"delete":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deletePurecloud"}},"/api/v2/identityproviders/salesforce":{"get":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSalesforce"},"put":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSalesforce"},"delete":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSalesforce"}},"/api/v2/identityproviders/{providerId}":{"get":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProviderId"},"put":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProviderId"},"delete":{"tags":["Identity Provider"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProviderId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLanguages"},"post":{"tags":["Languages"],"summary":"Create Language","description":"","operationId":"postLanguages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Language","required":false,"schema":{"$ref":"#/definitions/Language"}}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postLanguages"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLanguageId"},"put":{"tags":["Languages"],"summary":"Update Language","description":"","operationId":"putLanguageId","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Language","required":false,"schema":{"$ref":"#/definitions/Language"}}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putLanguageId"},"delete":{"tags":["Languages"],"summary":"Delete Language","description":"","operationId":"deleteLanguageId","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language 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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteLanguageId"}},"/api/v2/locations":{"get":{"tags":["Locations"],"summary":"Get a list of all locations.","description":"","operationId":"getLocations","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":"Sort order","required":false,"type":"string","enum":["asc","desc"]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Location"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLocations"}},"/api/v2/locations/search":{"get":{"tags":["Search","Locations"],"summary":"Search using q64","description":"","operationId":"getSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","required":false,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSearch"},"post":{"tags":["Search","Locations"],"summary":"Search","description":"","operationId":"postSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":false,"schema":{"$ref":"#/definitions/LocationSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSearch"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getLocationId"}},"/api/v2/notifications/availabletopics":{"get":{"tags":["Notifications"],"summary":"Get available notification topics.","description":"","operationId":"getAvailabletopics","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["description","schema"]},"collectionFormat":"multi"}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getAvailabletopics"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postChannels"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","notification.invalid.topic":"The subscription topic is not valid."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","notification.invalid.topic":"The subscription topic is not valid."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteChannelsChannelIdSubscriptions"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postClients"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteClientsClientId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postClientsClientIdSecret"}},"/api/v2/organizations/me":{"get":{"tags":["Organization"],"summary":"Get organization.","description":"","operationId":"getMe","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMe"}},"/api/v2/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"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getOrphanrecordings"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteOrphanId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postAudits"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallabletimesets"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCallabletimesetsCallabletimesetId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCallanalysisresponsesets"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","call.analysis.response.set.in.use":"The dialer call analysis response set is in use.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCallanalysisresponsesetsCallanalysissetId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCampaigns"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCampaignsProgress"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","edge.group.has.no.active.edges":"","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.update":"","invalid.update.bad.status.transition":"","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","campaign.in.use":"The campaign is in use.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCampaignsCampaignId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putCampaignsCampaignIdAgentsUserId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCampaignsCampaignIdCallbackSchedule"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCampaignsCampaignIdDiagnostics"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCampaignsCampaignIdProgress"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getCampaignsCampaignIdStats"}},"/api/v2/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":"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postContactlists"}},"/api/v2/outbound/contactlists/{contactListId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer contact list.","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":"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The dialer contact list was not found.","not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","contact.list.in.use":"The contact list is in use.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteContactlistsContactlistId"}},"/api/v2/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/DialerContact"}}},{"name":"priority","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.contact.columns":"The contact columns are invalid.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postContactlistsContactlistIdContacts"}},"/api/v2/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/DialerContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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/DialerContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteContactlistsContactlistIdContactsContactId"}},"/api/v2/outbound/contactlists/{contactListId}/export":{"get":{"tags":["Outbound"],"summary":"Get the URI of a contact list export.","description":"","operationId":"getContactlistsContactlistIdExport","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"name":"download","in":"query","description":"Redirect to download uri","required":false,"type":"string","default":"false"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExportUri"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContactlistsContactlistIdExport"},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postContactlistsContactlistIdExport"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getContactlistsContactlistIdImportstatus"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationsConversationIdDnc"}},"/api/v2/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":"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDnclists"}},"/api/v2/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":"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The dialer DNC list was not found.","not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","dnc.list.in.use":"The dialer DNC list is in use.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteDnclistsDnclistId"}},"/api/v2/outbound/dnclists/{dncListId}/export":{"get":{"tags":["Outbound"],"summary":"Get the URI of a DNC list export.","description":"","operationId":"getDnclistsDnclistIdExport","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"download","in":"query","description":"Redirect to download uri","required":false,"type":"string","default":"false"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExportUri"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDnclistsDnclistIdExport"},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDnclistsDnclistIdExport"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getDnclistsDnclistIdImportstatus"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postDnclistsDnclistIdPhonenumbers"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRulesets"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteRulesetsRulesetId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchedulesCampaigns"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.not.found":"The dialer campaign was not found.","not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSchedulesCampaignsCampaignId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSchedulesSequences"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSchedulesSequencesSequenceId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"A campaign sequence with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSequences"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","campaign.sequence.is.empty":"The dialer campaign sequence is empty.","campaign.sequence.missing.campaign":"The dialer campaign sequence is missing the campaign.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSequencesSequenceId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putWrapupcodemappings"}},"/api/v2/presencedefinitions":{"get":{"tags":["Presence"],"summary":"Get an Organization's list of Presence Definitions","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"},{"name":"deleted","in":"query","description":"Deleted query can be true, false or all","required":false,"type":"string","default":"false"}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPresencedefinitions"},"post":{"tags":["Presence"],"summary":"Create a Presence Definition","description":"","operationId":"postPresencedefinitions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Presence Definition 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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postPresencedefinitions"}},"/api/v2/presencedefinitions/{presenceId}":{"get":{"tags":["Presence"],"summary":"Get a Presence Definition","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPresenceId"},"put":{"tags":["Presence"],"summary":"Update a Presence Definition","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putPresenceId"},"delete":{"tags":["Presence"],"summary":"Delete a Presence Definition","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deletePresenceId"}},"/api/v2/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":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getAgentsActivity"}},"/api/v2/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":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"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":true,"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postCalibrations"}},"/api/v2/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":true,"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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":true,"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteCalibrationsCalibrationId"}},"/api/v2/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":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getConversationsConversationIdAudits"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postConversationsConversationIdEvaluations"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteConversationsConversationIdEvaluationsEvaluationId"}},"/api/v2/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":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEvaluationsQuery"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEvaluationsScoring"}},"/api/v2/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":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEvaluatorsActivity"}},"/api/v2/quality/forms":{"get":{"tags":["Quality"],"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":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getForms"},"post":{"tags":["Quality"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postForms"}},"/api/v2/quality/forms/{formId}":{"get":{"tags":["Quality"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFormsFormId"},"put":{"tags":["Quality"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putFormsFormId"},"delete":{"tags":["Quality"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteFormsFormId"}},"/api/v2/quality/forms/{formId}/versions":{"get":{"tags":["Quality"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getFormsFormIdVersions"}},"/api/v2/quality/keywordsets":{"get":{"tags":["Quality"],"summary":"Get the list of keyword sets","description":"","operationId":"getKeywordsets","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":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"name","in":"query","description":"the keyword set name - used for filtering results in searches.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeywordSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getKeywordsets"},"post":{"tags":["Quality"],"summary":"Create a Keyword Set","description":"","operationId":"postKeywordsets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"keywordSet","required":false,"schema":{"$ref":"#/definitions/KeywordSet"}},{"name":"expand","in":"query","description":"queueId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeywordSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postKeywordsets"},"delete":{"tags":["Quality"],"summary":"Delete keyword sets","description":"Bulk delete of keyword sets; this will only delete the keyword sets that match the ids specified in the query param.","operationId":"deleteKeywordsets","produces":["application/json"],"parameters":[{"name":"ids","in":"query","description":"A comma-delimited list of valid KeywordSet ids","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteKeywordsets"}},"/api/v2/quality/keywordsets/{keywordSetId}":{"get":{"tags":["Quality"],"summary":"Get a keywordSet by id.","description":"","operationId":"getKeywordsetsKeywordsetId","produces":["application/json"],"parameters":[{"name":"keywordSetId","in":"path","description":"KeywordSet ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeywordSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getKeywordsetsKeywordsetId"},"put":{"tags":["Quality"],"summary":"Update a keywordSet to the specified keywordSet via PUT.","description":"","operationId":"putKeywordsetsKeywordsetId","produces":["application/json"],"parameters":[{"name":"keywordSetId","in":"path","description":"KeywordSet ID","required":true,"type":"string"},{"in":"body","name":"body","description":"keywordSet","required":false,"schema":{"$ref":"#/definitions/KeywordSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeywordSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putKeywordsetsKeywordsetId"},"delete":{"tags":["Quality"],"summary":"Delete a keywordSet by id.","description":"","operationId":"deleteKeywordsetsKeywordsetId","produces":["application/json"],"parameters":[{"name":"keywordSetId","in":"path","description":"KeywordSet 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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteKeywordsetsKeywordsetId"}},"/api/v2/quality/publishedforms":{"get":{"tags":["Quality"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPublishedforms"},"post":{"tags":["Quality"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postPublishedforms"}},"/api/v2/quality/publishedforms/{formId}":{"get":{"tags":["Quality"],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPublishedformsFormId"}},"/api/v2/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":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteMediaretentionpolicies"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchMediaretentionpoliciesPolicyId"}},"/api/v2/recording/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postRecordingkeys"}},"/api/v2/recording/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putRecordingkeysRotationschedule"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putSettings"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postLibraries"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"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"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteLibrariesLibraryId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postResponses"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postResponsesQuery"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"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"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteResponsesResponseId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEmailDomains"}},"/api/v2/routing/email/domains/{domainId}":{"delete":{"tags":["Routing"],"summary":"Delete a domain","description":"","operationId":"deleteEmailDomainsDomainId","produces":["application/json"],"parameters":[{"name":"domainId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteEmailDomainsDomainId"}},"/api/v2/routing/email/domains/{domainName}/routes":{"get":{"tags":["Routing"],"summary":"Get routes","description":"","operationId":"getEmailDomainsDomainnameRoutes","produces":["application/json"],"parameters":[{"name":"domainName","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailDomainsDomainnameRoutes"},"post":{"tags":["Routing"],"summary":"Create a route","description":"","operationId":"postEmailDomainsDomainnameRoutes","produces":["application/json"],"parameters":[{"name":"domainName","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postEmailDomainsDomainnameRoutes"}},"/api/v2/routing/email/domains/{domainName}/routes/{routeId}":{"get":{"tags":["Routing"],"summary":"Get a route","description":"","operationId":"getEmailDomainsDomainnameRoutesRouteId","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailDomainsDomainnameRoutesRouteId"},"put":{"tags":["Routing"],"summary":"Update a route","description":"","operationId":"putEmailDomainsDomainnameRoutesRouteId","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putEmailDomainsDomainnameRoutesRouteId"},"delete":{"tags":["Routing"],"summary":"Delete a route","description":"","operationId":"deleteEmailDomainsDomainnameRoutesRouteId","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteEmailDomainsDomainnameRoutesRouteId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getEmailSetup"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required.field.missing":"A required field is missing a value."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQueues"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"A queue with that name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteQueuesQueueId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getQueuesQueueIdEstimatedwaittime"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchQueuesQueueIdUsers"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchQueuesQueueIdUsersMemberId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postQueuesQueueIdWrapupcodes"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteQueuesQueueIdWrapupcodesCodeId"}},"/api/v2/routing/skills":{"get":{"tags":["Routing"],"summary":"Get the list of routing 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"}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSkills"},"post":{"tags":["Routing"],"summary":"Create Skill","description":"","operationId":"postSkills","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Skill","required":false,"schema":{"$ref":"#/definitions/RoutingSkill"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSkills"}},"/api/v2/routing/skills/{skillId}":{"get":{"tags":["Routing"],"summary":"Get Routing Skill","description":"","operationId":"getSkillsSkillId","produces":["application/json"],"parameters":[{"name":"skillId","in":"path","description":"Skill ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSkillsSkillId"},"delete":{"tags":["Routing"],"summary":"Delete Routing Skill","description":"","operationId":"deleteSkillsSkillId","produces":["application/json"],"parameters":[{"name":"skillId","in":"path","description":"Skill 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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteSkillsSkillId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteUtilization"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postWrapupcodes"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteWrapupcodesCodeId"}},"/api/v2/search":{"get":{"tags":["Search","Suggest"],"summary":"Search using q64","description":"","operationId":"getSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","required":false,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"profile","in":"query","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSearch"},"post":{"tags":["Search","Suggest"],"summary":"Search","description":"","operationId":"postSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":false,"schema":{"$ref":"#/definitions/SearchRequest"}},{"name":"profile","in":"query","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSearch"}},"/api/v2/search/suggest":{"get":{"tags":["Search","Suggest"],"summary":"Suggest using q64","description":"","operationId":"getSuggest","produces":["application/json"],"parameters":[{"name":"q64","in":"query","required":false,"type":"string"},{"name":"profile","in":"query","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSuggest"},"post":{"tags":["Search","Suggest"],"summary":"Suggest","description":"","operationId":"postSuggest","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":false,"schema":{"$ref":"#/definitions/SuggestSearchRequest"}},{"name":"profile","in":"query","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSuggest"}},"/api/v2/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"},{"name":"lineAppearanceId","in":"query","description":"lineAppearanceId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getStations"}},"/api/v2/stations/{stationId}":{"get":{"tags":["Stations"],"summary":"Get station.","description":"","operationId":"getStationId","produces":["application/json"],"parameters":[{"name":"stationId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getStationId"}},"/api/v2/stations/{stationId}/associateduser":{"delete":{"tags":["Stations"],"summary":"Unassigns the user assigned to this station","description":"","operationId":"deleteStationIdAssociateduser","produces":["application/json"],"parameters":[{"name":"stationId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteStationIdAssociateduser"}},"/api/v2/systempresences":{"get":{"tags":["Presence"],"summary":"Get the list of SystemPresences","description":"","operationId":"getSystempresences","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSystempresences"}},"/api/v2/telephony/providers/edges":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of edges.","description":"","operationId":"getProvidersEdges","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdges"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a edge.","description":"","operationId":"postProvidersEdges","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdges"}},"/api/v2/telephony/providers/edges/addressvalidation":{"post":{"tags":["Telephony Providers Edge"],"summary":"Validates a street address","description":"","operationId":"postProvidersEdgesAddressvalidation","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesAddressvalidation"}},"/api/v2/telephony/providers/edges/availablelanguages":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of available languages.","description":"","operationId":"getProvidersEdgesAvailablelanguages","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableLanguageList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesAvailablelanguages"}},"/api/v2/telephony/providers/edges/certificateauthorities":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of certificate authorities.","description":"","operationId":"getProvidersEdgesCertificateauthorities","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesCertificateauthorities"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a certificate authority.","description":"","operationId":"postProvidersEdgesCertificateauthorities","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesCertificateauthorities"}},"/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a certificate authority.","description":"","operationId":"getProvidersEdgesCertificateauthoritiesCertificateId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesCertificateauthoritiesCertificateId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a certificate authority.","description":"","operationId":"putProvidersEdgesCertificateauthoritiesCertificateId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesCertificateauthoritiesCertificateId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a certificate authority.","description":"","operationId":"deleteProvidersEdgesCertificateauthoritiesCertificateId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesCertificateauthoritiesCertificateId"}},"/api/v2/telephony/providers/edges/didpools":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of DID Pools","description":"","operationId":"getProvidersEdgesDidpools","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesDidpools"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new DID pool","description":"","operationId":"postProvidersEdgesDidpools","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesDidpools"}},"/api/v2/telephony/providers/edges/didpools/{didPoolId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a DID Pool by ID.","description":"","operationId":"getProvidersEdgesDidpoolsDidpoolId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesDidpoolsDidpoolId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a DID Pool by ID.","description":"","operationId":"putProvidersEdgesDidpoolsDidpoolId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesDidpoolsDidpoolId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a DID Pool by ID.","description":"","operationId":"deleteProvidersEdgesDidpoolsDidpoolId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesDidpoolsDidpoolId"}},"/api/v2/telephony/providers/edges/dids":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of DIDs","description":"","operationId":"getProvidersEdgesDids","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesDids"}},"/api/v2/telephony/providers/edges/dids/{didId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a DID by ID.","description":"","operationId":"getProvidersEdgesDidsDidId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesDidsDidId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a DID by ID.","description":"","operationId":"putProvidersEdgesDidsDidId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesDidsDidId"}},"/api/v2/telephony/providers/edges/edgegroups":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of edge groups.","description":"","operationId":"getProvidersEdgesEdgegroups","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgegroups"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge group.","description":"","operationId":"postProvidersEdgesEdgegroups","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"An edge group with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required.field.missing":"A required field is missing a value."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesEdgegroups"}},"/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge group.","description":"","operationId":"getProvidersEdgesEdgegroupsEdgegroupId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgegroupsEdgegroupId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an edge group.","description":"","operationId":"putProvidersEdgesEdgegroupsEdgegroupId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"An edge group with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required.field.missing":"A required field is missing a value."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesEdgegroupsEdgegroupId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an edge group.","description":"","operationId":"deleteProvidersEdgesEdgegroupsEdgegroupId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesEdgegroupsEdgegroupId"}},"/api/v2/telephony/providers/edges/edgeversionreport":{"get":{"tags":["Telephony Providers Edge"],"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":"getProvidersEdgesEdgeversionreport","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeversionreport"}},"/api/v2/telephony/providers/edges/endpoints":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get endpoints","description":"","operationId":"getProvidersEdgesEndpoints","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEndpoints"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create endpoint","description":"","operationId":"postProvidersEdgesEndpoints","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesEndpoints"}},"/api/v2/telephony/providers/edges/endpoints/{endpointId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get endpoint","description":"","operationId":"getProvidersEdgesEndpointsEndpointId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEndpointsEndpointId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update endpoint","description":"","operationId":"putProvidersEdgesEndpointsEndpointId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesEndpointsEndpointId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete endpoint","description":"","operationId":"deleteProvidersEdgesEndpointsEndpointId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesEndpointsEndpointId"}},"/api/v2/telephony/providers/edges/extensionpools":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of extension pools","description":"","operationId":"getProvidersEdgesExtensionpools","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesExtensionpools"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new extension pool","description":"","operationId":"postProvidersEdgesExtensionpools","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesExtensionpools"}},"/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an extension pool by ID","description":"","operationId":"getProvidersEdgesExtensionpoolsExtensionpoolId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesExtensionpoolsExtensionpoolId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an extension pool by ID","description":"","operationId":"putProvidersEdgesExtensionpoolsExtensionpoolId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesExtensionpoolsExtensionpoolId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an extension pool by ID","description":"","operationId":"deleteProvidersEdgesExtensionpoolsExtensionpoolId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesExtensionpoolsExtensionpoolId"}},"/api/v2/telephony/providers/edges/extensions":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of extensions","description":"","operationId":"getProvidersEdgesExtensions","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesExtensions"}},"/api/v2/telephony/providers/edges/extensions/{extensionId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an extension by ID.","description":"","operationId":"getProvidersEdgesExtensionsExtensionId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesExtensionsExtensionId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an extension by ID.","description":"","operationId":"putProvidersEdgesExtensionsExtensionId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesExtensionsExtensionId"}},"/api/v2/telephony/providers/edges/linebasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of line base settings objects","description":"","operationId":"getProvidersEdgesLinebasesettings","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesLinebasesettings"}},"/api/v2/telephony/providers/edges/linebasesettings/{lineBaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a line base settings object by ID","description":"","operationId":"getProvidersEdgesLinebasesettingsLinebaseId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesLinebasesettingsLinebaseId"}},"/api/v2/telephony/providers/edges/lines":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Lines","description":"","operationId":"getProvidersEdgesLines","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesLines"}},"/api/v2/telephony/providers/edges/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":"getProvidersEdgesLinesTemplate","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesLinesTemplate"}},"/api/v2/telephony/providers/edges/lines/{lineId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Line by ID","description":"","operationId":"getProvidersEdgesLinesLineId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesLinesLineId"}},"/api/v2/telephony/providers/edges/outboundroutes":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get outbound routes","description":"","operationId":"getProvidersEdgesOutboundroutes","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesOutboundroutes"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create outbound rule","description":"","operationId":"postProvidersEdgesOutboundroutes","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"An outbound route with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required.field.missing":"A required field is missing a value."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesOutboundroutes"}},"/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get outbound route","description":"","operationId":"getProvidersEdgesOutboundroutesOutboundrouteId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesOutboundroutesOutboundrouteId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update outbound route","description":"","operationId":"putProvidersEdgesOutboundroutesOutboundrouteId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"An outbound route with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required.field.missing":"A required field is missing a value."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesOutboundroutesOutboundrouteId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete Outbound Route","description":"","operationId":"deleteProvidersEdgesOutboundroutesOutboundrouteId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesOutboundroutesOutboundrouteId"}},"/api/v2/telephony/providers/edges/phonebasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Phone Base Settings objects","description":"","operationId":"getProvidersEdgesPhonebasesettings","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesPhonebasesettings"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new Phone Base Settings object","description":"","operationId":"postProvidersEdgesPhonebasesettings","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesPhonebasesettings"}},"/api/v2/telephony/providers/edges/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":"getProvidersEdgesPhonebasesettingsAvailablemetabases","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesPhonebasesettingsAvailablemetabases"}},"/api/v2/telephony/providers/edges/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":"getProvidersEdgesPhonebasesettingsTemplate","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesPhonebasesettingsTemplate"}},"/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone Base Settings object by ID","description":"","operationId":"getProvidersEdgesPhonebasesettingsPhonebaseId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesPhonebasesettingsPhonebaseId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Phone Base Settings by ID","description":"","operationId":"putProvidersEdgesPhonebasesettingsPhonebaseId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesPhonebasesettingsPhonebaseId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Phone Base Settings by ID","description":"","operationId":"deleteProvidersEdgesPhonebasesettingsPhonebaseId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesPhonebasesettingsPhonebaseId"}},"/api/v2/telephony/providers/edges/phones":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Phone Instances","description":"","operationId":"getProvidersEdgesPhones","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":"webRtcUser.id","in":"query","description":"Filter by webRtcUser.id","required":false,"type":"string"},{"name":"phoneBaseSettings.id","in":"query","description":"Filter by phoneBaseSettings.id","required":false,"type":"string"},{"name":"lines.loggedInUser.id","in":"query","description":"Filter by lines.loggedInUser.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","status","status.primaryEdgesStatus","status.secondaryEdgesStatus","phoneBaseSettings","lines"]},"collectionFormat":"multi"},{"name":"fields","in":"query","description":"Fields and properties to get, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["webRtcUser","properties.*","lines.loggedInUser"]},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesPhones"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new Phone","description":"","operationId":"postProvidersEdgesPhones","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesPhones"}},"/api/v2/telephony/providers/edges/phones/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot Multiple Phones","description":"","operationId":"postProvidersEdgesPhonesReboot","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.phone.no.active.edge":"Phone is not connected to an active edge and cannot be rebooted.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesPhonesReboot"}},"/api/v2/telephony/providers/edges/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":"getProvidersEdgesPhonesTemplate","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesPhonesTemplate"}},"/api/v2/telephony/providers/edges/phones/{phoneId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone by ID","description":"","operationId":"getProvidersEdgesPhonesPhoneId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesPhonesPhoneId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Phone by ID","description":"","operationId":"putProvidersEdgesPhonesPhoneId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesPhonesPhoneId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Phone by ID","description":"","operationId":"deleteProvidersEdgesPhonesPhoneId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesPhonesPhoneId"}},"/api/v2/telephony/providers/edges/phones/{phoneId}/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot a Phone","description":"","operationId":"postProvidersEdgesPhonesPhoneIdReboot","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.phone.no.active.edge":"Phone is not connected to an active edge and cannot be rebooted.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesPhonesPhoneIdReboot"}},"/api/v2/telephony/providers/edges/sites":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of Sites.","description":"","operationId":"getProvidersEdgesSites","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesSites"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a Site.","description":"","operationId":"postProvidersEdgesSites","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesSites"}},"/api/v2/telephony/providers/edges/sites/{siteId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Site by ID.","description":"","operationId":"getProvidersEdgesSitesSiteId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesSitesSiteId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Site by ID.","description":"","operationId":"putProvidersEdgesSitesSiteId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesSitesSiteId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Site by ID","description":"","operationId":"deleteProvidersEdgesSitesSiteId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesSitesSiteId"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of Number Plans for this Site.","description":"","operationId":"getProvidersEdgesSitesSiteIdNumberplans","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesSitesSiteIdNumberplans"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update the list of Number Plans.","description":"","operationId":"putProvidersEdgesSitesSiteIdNumberplans","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","error.updating.number.plans":"There was a problem updating number plans.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesSitesSiteIdNumberplans"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Classifications for this Site","description":"","operationId":"getProvidersEdgesSitesSiteIdNumberplansClassifications","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesSitesSiteIdNumberplansClassifications"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Number Plan by ID.","description":"","operationId":"getProvidersEdgesSitesSiteIdNumberplansNumberplanId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesSitesSiteIdNumberplansNumberplanId"}},"/api/v2/telephony/providers/edges/sites/{siteId}/rebalance":{"post":{"tags":["Telephony Providers Edge"],"summary":"Triggers the rebalance operation.","description":"","operationId":"postProvidersEdgesSitesSiteIdRebalance","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesSitesSiteIdRebalance"}},"/api/v2/telephony/providers/edges/timezones":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Edge-compatible time zones","description":"","operationId":"getProvidersEdgesTimezones","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesTimezones"}},"/api/v2/telephony/providers/edges/trunkbasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get Trunk Base Settings listing","description":"","operationId":"getProvidersEdgesTrunkbasesettings","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":"recordingEnabled","in":"query","description":"Filter trunks by recording enabled","required":false,"type":"boolean"}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesTrunkbasesettings"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a Trunk Base Settings object","description":"","operationId":"postProvidersEdgesTrunkbasesettings","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"A trunk with that name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required.field.missing":"A required field is missing a value."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesTrunkbasesettings"}},"/api/v2/telephony/providers/edges/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":"getProvidersEdgesTrunkbasesettingsAvailablemetabases","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesTrunkbasesettingsAvailablemetabases"}},"/api/v2/telephony/providers/edges/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":"getProvidersEdgesTrunkbasesettingsTemplate","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesTrunkbasesettingsTemplate"}},"/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk Base Settings object by ID","description":"","operationId":"getProvidersEdgesTrunkbasesettingsTrunkbasesettingsId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesTrunkbasesettingsTrunkbasesettingsId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Trunk Base Settings object by ID","description":"","operationId":"putProvidersEdgesTrunkbasesettingsTrunkbasesettingsId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"A trunk with that name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","required.field.missing":"A required field is missing a value."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesTrunkbasesettingsTrunkbasesettingsId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Trunk Base Settings object by ID","description":"","operationId":"deleteProvidersEdgesTrunkbasesettingsTrunkbasesettingsId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","delete.referenced.entity":"The trunk is being referenced.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesTrunkbasesettingsTrunkbasesettingsId"}},"/api/v2/telephony/providers/edges/trunks":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of available trunks.","description":"Trunks are created by assigning trunk base settings to an Edge or Edge Group.","operationId":"getProvidersEdgesTrunks","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":"edge.id","in":"query","description":"Filter by Edge Ids","required":false,"type":"string"},{"name":"trunkBase.id","in":"query","description":"Filter by Trunk Base Ids","required":false,"type":"string"},{"name":"trunkType","in":"query","description":"Filter by a Trunk type","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesTrunks"}},"/api/v2/telephony/providers/edges/trunks/{trunkId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk by ID","description":"","operationId":"getProvidersEdgesTrunksTrunkId","produces":["application/json"],"parameters":[{"name":"trunkId","in":"path","description":"Trunk ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trunk"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesTrunksTrunkId"}},"/api/v2/telephony/providers/edges/trunkswithrecording":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get Counts of trunks that have recording disabled or enabled","description":"","operationId":"getProvidersEdgesTrunkswithrecording","produces":["application/json"],"parameters":[{"name":"trunkType","in":"query","description":"The type of this trunk base.","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkRecordingEnabledCount"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesTrunkswithrecording"}},"/api/v2/telephony/providers/edges/{edgeId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge.","description":"","operationId":"getProvidersEdgesEdgeId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a edge.","description":"","operationId":"putProvidersEdgesEdgeId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","edge.group.required":"The edge group field is missing a value.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","site.required":"The site field is missing a value."}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesEdgeId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a edge.","description":"","operationId":"deleteProvidersEdgesEdgeId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesEdgeId"}},"/api/v2/telephony/providers/edges/{edgeId}/lines":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of lines.","description":"","operationId":"getProvidersEdgesEdgeIdLines","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeIdLines"}},"/api/v2/telephony/providers/edges/{edgeId}/lines/{lineId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get line","description":"","operationId":"getProvidersEdgesEdgeIdLinesLineId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeIdLinesLineId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a line.","description":"","operationId":"putProvidersEdgesEdgeIdLinesLineId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesEdgeIdLinesLineId"}},"/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge logical interfaces.","description":"Retrieve a list of all configured logical interfaces from a specific edge.","operationId":"getProvidersEdgesEdgeIdLogicalinterfaces","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeIdLogicalinterfaces"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge logical interface.","description":"Create","operationId":"postProvidersEdgesEdgeIdLogicalinterfaces","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"A logical interface with that vlanTagId already exists on this port.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesEdgeIdLogicalinterfaces"}},"/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an edge logical interface","description":"","operationId":"getProvidersEdgesEdgeIdLogicalinterfacesInterfaceId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeIdLogicalinterfacesInterfaceId"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an edge logical interface.","description":"","operationId":"putProvidersEdgesEdgeIdLogicalinterfacesInterfaceId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"A logical interface with that vlanTagId already exists on this port.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putProvidersEdgesEdgeIdLogicalinterfacesInterfaceId"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an edge logical interface","description":"","operationId":"deleteProvidersEdgesEdgeIdLogicalinterfacesInterfaceId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesEdgeIdLogicalinterfacesInterfaceId"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs":{"post":{"tags":["Telephony Providers Edge"],"summary":"Create a job to upload a list of Edge logs.","description":"","operationId":"postProvidersEdgesEdgeIdLogsJobs","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesEdgeIdLogsJobs"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an Edge logs job.","description":"","operationId":"getProvidersEdgesEdgeIdLogsJobsJobId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeIdLogsJobsJobId"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload":{"post":{"tags":["Telephony Providers Edge"],"summary":"Request that the specified fileIds be uploaded from the Edge.","description":"","operationId":"postProvidersEdgesEdgeIdLogsJobsJobIdUpload","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesEdgeIdLogsJobsJobIdUpload"}},"/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Retrieve a list of all configured physical interfaces from a specific edge.","description":"","operationId":"getProvidersEdgesEdgeIdPhysicalinterfaces","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeIdPhysicalinterfaces"}},"/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge physical interface.","description":"Retrieve a physical interface from a specific edge.","operationId":"getProvidersEdgesEdgeIdPhysicalinterfacesInterfaceId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeIdPhysicalinterfacesInterfaceId"}},"/api/v2/telephony/providers/edges/{edgeId}/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot an Edge","description":"","operationId":"postProvidersEdgesEdgeIdReboot","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesEdgeIdReboot"}},"/api/v2/telephony/providers/edges/{edgeId}/softwareupdate":{"get":{"tags":["Telephony Providers Edge"],"summary":"Gets software update status information about any edge.","description":"","operationId":"getProvidersEdgesEdgeIdSoftwareupdate","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeIdSoftwareupdate"},"post":{"tags":["Telephony Providers Edge"],"summary":"Starts a software update for this edge.","description":"","operationId":"postProvidersEdgesEdgeIdSoftwareupdate","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesEdgeIdSoftwareupdate"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Cancels any in-progress update for this edge.","description":"","operationId":"deleteProvidersEdgesEdgeIdSoftwareupdate","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteProvidersEdgesEdgeIdSoftwareupdate"}},"/api/v2/telephony/providers/edges/{edgeId}/softwareversions":{"get":{"tags":["Telephony Providers Edge"],"summary":"Gets all the available software versions for this edge.","description":"","operationId":"getProvidersEdgesEdgeIdSoftwareversions","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getProvidersEdgesEdgeIdSoftwareversions"}},"/api/v2/telephony/providers/edges/{edgeId}/unpair":{"post":{"tags":["Telephony Providers Edge"],"summary":"Unpair an Edge","description":"","operationId":"postProvidersEdgesEdgeIdUnpair","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postProvidersEdgesEdgeIdUnpair"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getTimezones"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteMe"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserrecordings"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSummary"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteRecordingId"}},"/api/v2/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 media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","NONE"]}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getRecordingIdMedia"}},"/api/v2/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":"The list of user ids to get. Paging is ignored if ids are specified","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization"]},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUsers"},"post":{"tags":["Users"],"summary":"Create user","description":"","operationId":"postUsers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"User","required":false,"schema":{"$ref":"#/definitions/CreateUser"}}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postUsers"}},"/api/v2/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","presence","conversationSummary","outOfOffice","geolocation","station","authorization","date","geolocationsettings","organization","presencedefinitions","locations"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserMe"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMe"}},"/api/v2/users/search":{"get":{"tags":["Search","Users"],"summary":"Search using q64","description":"","operationId":"getSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","required":false,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getSearch"},"post":{"tags":["Search","Users"],"summary":"Search","description":"","operationId":"postSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":false,"schema":{"$ref":"#/definitions/UserSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postSearch"}},"/api/v2/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","presence","conversationSummary","outOfOffice","geolocation","station","authorization"]},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserId"},"delete":{"tags":["Users"],"summary":"Delete user","description":"","operationId":"deleteUserId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User 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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteUserId"},"patch":{"tags":["Users"],"summary":"Update user","description":"","operationId":"patchUserId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserIdCallforwarding"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserIdGeolocationsClientId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postUserIdGreetings"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdGreetingsDefaults"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdOutofoffice"}},"/api/v2/users/{userId}/presences/{sourceId}":{"get":{"tags":["Presence"],"summary":"Get a user's Presence","description":"","operationId":"getUserIdPresencesSourceId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"sourceId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdPresencesSourceId"},"patch":{"tags":["Presence"],"summary":"Patch a user's Presence","description":"The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.","operationId":"patchUserIdPresencesSourceId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Source","required":true,"type":"string"},{"in":"body","name":"body","required":false,"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserIdPresencesSourceId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserIdQueues"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserIdQueuesQueueId"}},"/api/v2/users/{userId}/roles":{"get":{"tags":["Authorization","Users"],"summary":"Returns a listing of roles and permissions for a 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":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdRoles"},"put":{"tags":["Authorization","Users"],"summary":"Sets the user's roles","description":"","operationId":"putUserIdRoles","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":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdRoles"},"delete":{"tags":["Authorization","Users"],"summary":"Removes all the roles from the user.","description":"","operationId":"deleteUserIdRoles","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteUserIdRoles"}},"/api/v2/users/{userId}/routingskills":{"get":{"tags":["Routing","Users"],"summary":"List routing skills for user","description":"","operationId":"getUserIdRoutingskills","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"},{"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/UserSkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdRoutingskills"},"post":{"tags":["Routing","Users"],"summary":"Add routing skill to user","description":"","operationId":"postUserIdRoutingskills","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Skill","required":false,"schema":{"$ref":"#/definitions/UserRoutingSkill"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"postUserIdRoutingskills"}},"/api/v2/users/{userId}/routingskills/{skillId}":{"put":{"tags":["Routing","Users"],"summary":"Update routing skill proficiency or state.","description":"","operationId":"putUserIdRoutingskillsSkillId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"skillId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","description":"Skill","required":false,"schema":{"$ref":"#/definitions/UserRoutingSkill"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdRoutingskillsSkillId"},"delete":{"tags":["Routing","Users"],"summary":"Remove routing skill from user","description":"","operationId":"deleteUserIdRoutingskillsSkillId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"skillId","in":"path","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteUserIdRoutingskillsSkillId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"An invalid routing status transition was attempted.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdRoutingstatus"}},"/api/v2/users/{userId}/station":{"get":{"tags":["Users"],"summary":"Get station information for user","description":"","operationId":"getUserIdStation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserStations"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserIdStation"}},"/api/v2/users/{userId}/station/associatedstation":{"delete":{"tags":["Users"],"summary":"Clear associated station","description":"","operationId":"deleteUserIdStationAssociatedstation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteUserIdStationAssociatedstation"}},"/api/v2/users/{userId}/station/associatedstation/{stationId}":{"put":{"tags":["Users"],"summary":"Set associated station","description":"","operationId":"putUserIdStationAssociatedstationStationId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"stationId","in":"path","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdStationAssociatedstationStationId"}},"/api/v2/users/{userId}/station/defaultstation":{"delete":{"tags":["Users"],"summary":"Clear default station","description":"","operationId":"deleteUserIdStationDefaultstation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteUserIdStationDefaultstation"}},"/api/v2/users/{userId}/station/defaultstation/{stationId}":{"put":{"tags":["Users"],"summary":"Set default station","description":"","operationId":"putUserIdStationDefaultstationStationId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"stationId","in":"path","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putUserIdStationDefaultstationStationId"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMailbox"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteMessages"}},"/api/v2/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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"deleteMessagesMessageId"}},"/api/v2/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 media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","NONE"]}],"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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getMessagesMessageIdMedia"}},"/api/v2/voicemail/policy":{"get":{"tags":["Voicemail"],"summary":"Get a policy","description":"","operationId":"getPolicy","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getPolicy"},"put":{"tags":["Voicemail"],"summary":"Update a policy","description":"","operationId":"putPolicy","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"putPolicy"}},"/api/v2/voicemail/userpolicies/{userId}":{"get":{"tags":["Voicemail"],"summary":"Get a user's voicemail policy","description":"","operationId":"getUserpoliciesUserId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"getUserpoliciesUserId"},"patch":{"tags":["Voicemail"],"summary":"Update a user's voicemail policy","description":"","operationId":"patchUserpoliciesUserId","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"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}},"401":{"description":"No authorization token (cookie or header) was found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authorization token (cookie or header) was found.","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","not.authorized":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too Many Requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.timeout":"The request timed out."}}},"security":[{"PureCloud Auth":["all"]}],"x-inin-method-name":"patchUserpoliciesUserId"}}},"securityDefinitions":{"PureCloud Auth":{"type":"oauth2","authorizationUrl":"https://auth.us-east-1.mypurecloud.com/authorize","flow":"implicit","scopes":{"all":"All the scopes"}}},"definitions":{"DocusignTemplateMapping":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"docusignTemplateId":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserAuthorization":{"type":"object","properties":{"roles":{"type":"array","items":{"$ref":"#/definitions/DomainRole"}},"permissions":{"type":"array","description":"A collection of the permissions granted by all assigned roles","readOnly":true,"items":{"type":"string"}},"permissionPolicies":{"type":"array","description":"The policies configured for assigned permissions.","readOnly":true,"items":{"$ref":"#/definitions/ResourcePermissionPolicy"}}}},"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/SharedEntity"},"memberType":{"type":"string","enum":["USER","PUBLIC"]},"member":{"$ref":"#/definitions/SharedEntity"},"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}}},"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."},"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"}}},"AggregationResultEntry":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"value":{"type":"string","description":"For termFrequency aggregations"},"gte":{"type":"number","description":"For numericRange aggregations"},"lt":{"type":"number","description":"For numericRange aggregations"}}},"EmailConversationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/EmailConversation"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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","required":["rules"],"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 time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"contactList":{"description":"The identifier of an example contact list that provides user-interface suggestions for contact-based conditions and actions","$ref":"#/definitions/UriReference"},"queue":{"description":"The identifier of an example queue that provides user-interface suggestions for wrap-up associated conditions","$ref":"#/definitions/UriReference"},"rules":{"type":"array","description":"The list of rules","items":{"$ref":"#/definitions/DialerRule"}},"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"}}},"SceneEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Scene"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"BillingContact":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"ivrCode":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ADFS":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"disabled":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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","inactive","deleted"]},"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}}},"EmailConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/EmailMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"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"}}},"EdgeLogsJobRequest":{"type":"object","properties":{"path":{"type":"string"},"query":{"type":"string"},"recurse":{"type":"boolean","default":false}}},"TimeZone":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"offset":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmailMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected on 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 this participant when disconnected on the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"purpose":{"type":"string","description":"The participant's purpose.  Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state.  Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","CONVERTING","UPLOADING","TRANSMITTING","NONE"]},"direction":{"type":"string","description":"The participant's direction.  Values can be: 'inbound' or 'outbound'","enum":["INBOUND","OUTBOUND"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold.","default":false},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up.","default":false},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/UriReference"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/UriReference"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorBody"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/UriReference"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up.","default":false},"subject":{"type":"string","description":"The subject of the email."},"messagesSent":{"type":"integer","format":"int32","description":"The number of messages that have been sent in this email conversation."}}},"ArchitectAuditMessage":{"type":"object","properties":{"action":{"type":"string","description":"The audit action","enum":["CHECKIN","PUBLISH","DELETE"]},"user":{"$ref":"#/definitions/AuditUser"},"timestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"changes":{"type":"array","items":{"$ref":"#/definitions/Change"}},"entity":{"$ref":"#/definitions/AuditEntity"}}},"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}}},"RoutingSkill":{"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 last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"state":{"type":"string","description":"The current state for this skill.","readOnly":true,"enum":["active","inactive","deleted"]},"version":{"type":"string","description":"Required when updating. Version must be the current version. Only the system can assign version.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallbackIdentifier":{"type":"object","required":["id","type"],"properties":{"type":{"type":"string","description":"The type of the associated callback participant","enum":["ACD","EXTERNAL"]},"id":{"type":"string","description":"The identifier of the callback"}}},"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}}},"AccountManager":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"}}},"PolicyActions":{"type":"object","properties":{"retainRecording":{"type":"boolean","description":"true to retain the recording associated with the conversation. Default = true","default":false},"deleteRecording":{"type":"boolean","description":"true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false","default":false},"alwaysDelete":{"type":"boolean","description":"true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false","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"},"initiateScreenRecording":{"$ref":"#/definitions/InitiateScreenRecording"}}},"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"}}},"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"},"envelopeId":{"type":"string","description":"Envelope id for the terms and conditions associated with this request."}}},"FaxSendRequest":{"type":"object","required":["addresses"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"addresses":{"type":"array","description":"A list of outbound fax dialing addresses. E.g. [phone] or 3175555555","items":{"type":"string"}},"documentId":{"type":"string","description":"DocumentId of Content Management artifact. If Content Management document is not used for faxing, documentId should be null"},"contentType":{"type":"string","description":"The content type that is going to be uploaded. If Content Management document is used for faxing, contentType will be ignored","enum":["application/pdf","image/tiff","application/msword","application/vnd.oasis.opendocument.text","application/vnd.openxmlformats-officedocument.wordprocessingml.document"]},"workspace":{"description":"Workspace in which the document should be stored. If Content Management document is used for faxing, workspace will be ignored","$ref":"#/definitions/Workspace"},"coverSheet":{"description":"Data for coversheet generation.","$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}}},"AggregationQuery":{"type":"object","properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","format":"date-time","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["conversationId","sessionId","mediaType","queueId","userId","participantId","participantName","direction","wrapUpCode","wrapUpNote","interactionType","requestedRoutingSkillId","requestedLanguageId","purpose","participantType","segmentType","disconnectType","errorCode","stationId","edgeId","dnis","ani","outboundCampaignId","outboundContactId","outboundContactListId","monitoredParticipantId","sourceSessionId","destinationSessionId","sourceConversationId","destinationConversationId","remoteNameDisplayable","sipResponseCode","q850ResponseCode","conference","groupId","roomId","addressFrom","addressTo","evaluationId","evaluatorId","contextId","formId","formName","eventTime"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/AnalyticsQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *).","items":{"type":"string","enum":["tSegmentDuration","oTotalCriticalScore","oTotalScore","nEvaluations","tAbandon","tIvr","tAnswered","tAcd","tTalk","tHeld","tTalkComplete","tHeldComplete","tAcw","tHandle","tWait","tAgentRoutingStatus","tOrganizationPresence","tSystemPresence","tUserResponseTime","tAgentResponseTime","nOffered","nOverSla","nTransferred","nOutboundAttempted","nOutboundConnected","nOutboundAbandoned","nError","oServiceTarget","oServiceLevel","tActive","tInactive","oActiveUsers","oMemberUsers","oActiveQueues","oMemberQueues","oInteracting","oWaiting"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')","default":false}}},"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","GROUP"]},"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":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"defaultSet":{"type":"array","description":"The default set of wrapup values","uniqueItems":true,"items":{"type":"string","enum":["CONTACT_UNCALLABLE","NUMBER_UNCALLABLE","RIGHT_PARTY_CONTACT"]}},"mapping":{"type":"object","description":"A map from wrapup code identifiers to a set of wrapup values","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/AuditUser"},"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/AuditEntity"},"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","inactive","deleted"]},"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}}},"BillingTaskResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"taskType":{"type":"string","enum":["GENERATE_PCV_USAGE_REPORT","GENERATE_BILLABLE_USAGE_REPORT","GENERATE_CONCURRENT_USAGE_REPORT","CREATE_QUOTE","CREATE_SALESFORCE_ACCOUNT","SUBMIT_QUOTE","GENERATE_CONTRACT","OTHER"]},"status":{"type":"string","enum":["IN_PROGRESS","SUCCEEDED","FAILED"]},"resultId":{"type":"string"},"resultUri":{"type":"string"},"resultDownloadUrl":{"type":"string"},"errorCode":{"type":"string"},"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"}}}},"UserStations":{"type":"object","properties":{"associatedStation":{"description":"Current associated station for this user.","readOnly":true,"$ref":"#/definitions/UserStation"},"effectiveStation":{"description":"The station where the user can be reached based on their default and associated station.","readOnly":true,"$ref":"#/definitions/UserStation"},"defaultStation":{"description":"Default station to be used if not associated with a station.","readOnly":true,"$ref":"#/definitions/UserStation"},"lastAssociatedStation":{"description":"Last associated station for this user.","readOnly":true,"$ref":"#/definitions/UserStation"}}},"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":{"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","inactive","deleted"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"mediaSettings":{"type":"object","additionalProperties":{"$ref":"#/definitions/MediaSetting"}},"bullseye":{"$ref":"#/definitions/Bullseye"},"acwSettings":{"$ref":"#/definitions/AcwSettings"},"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"},"entity":{"$ref":"#/definitions/AuditEntity"},"level":{"type":"string"},"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}}},"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":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"startDayOfWeek":{"type":"string"},"timezone":{"type":"string"},"version":{"type":"integer","format":"int32"},"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","inactive","deleted"]},"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}}},"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"}}},"ContactSort":{"type":"object","properties":{"fieldName":{"type":"string"},"direction":{"type":"string","enum":["ASC","DESC"]},"numeric":{"type":"boolean","default":false}}},"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}}},"ExportUri":{"type":"object","properties":{"uri":{"type":"string"},"exportTimestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"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"}}},"AuditFilter":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"operator":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}},"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"}}},"SearchCriteria":{"type":"object","properties":{"endValue":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"startValue":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}},"value":{"type":"string"},"operator":{"type":"string","enum":["AND","OR","NOT"]},"group":{"type":"array","items":{"$ref":"#/definitions/SearchCriteria"}},"type":{"type":"string","enum":["EXACT","CONTAINS","STARTS_WITH","REQUIRED_FIELDS","RANGE","DATE_RANGE","LESS_THAN","LESS_THAN_EQUAL_TO","GREATER_THAN","GREATER_THAN_EQUAL_TO","SIMPLE","TERM","TERMS","QUERY_STRING"]}}},"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"}}},"ConversationChat":{"type":"object","properties":{"state":{"type":"string","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","NONE"]},"id":{"type":"string"},"roomId":{"type":"string"},"recordingId":{"type":"string"},"segments":{"type":"array","items":{"$ref":"#/definitions/Segment"}},"held":{"type":"boolean","default":false},"direction":{"type":"string","enum":["INBOUND","OUTBOUND"]},"disconnectType":{"type":"string","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","TRANSFER_FORWARD","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"},"disconnectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"DialerAction":{"type":"object","required":["actionTypeName","type"],"properties":{"type":{"type":"string","description":"Type of the action","enum":["Action","modifyContactAttribute"]},"actionTypeName":{"type":"string","description":"Identifier of the action","enum":["DO_NOT_DIAL","MODIFY_CONTACT_ATTRIBUTE","SWITCH_TO_PREVIEW","APPEND_NUMBER_TO_DNC_LIST","SCHEDULE_CALLBACK"]},"updateOption":{"type":"string","description":"Indicator of the type of update action (applicable only to certain types of actions)","enum":["SET","INCREMENT","DECREMENT","CURRENT_TIME"]},"properties":{"type":"object","description":"Map of key-value pairs pertinent to the action (different actions require different properties)","additionalProperties":{"type":"string"}}}},"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}}},"ResponseFilter":{"type":"object","required":["name","operator","values"],"properties":{"name":{"type":"string","description":"Field to filter on. Allowed values are 'name' and 'libraryId."},"operator":{"type":"string","description":"Filter operation: IN, EQUALS, NOTEQUALS.","enum":["IN","EQUALS","NOTEQUALS"]},"values":{"type":"array","description":"Values to filter on.","items":{"type":"string"}}},"description":"Used to filter response queries"},"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}}},"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."},"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","required":["campaigns","currentCampaign","status"],"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 time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"campaigns":{"type":"array","description":"the ordered list of campaign identifiers","items":{"$ref":"#/definitions/UriReference"}},"currentCampaign":{"type":"integer","format":"int32","description":"the zero-based index of the current campaign in the campaigns list","readOnly":true},"status":{"type":"string","description":"status of the sequence","enum":["ON","OFF","COMPLETE"]},"stopMessage":{"type":"string","description":"if a sequence has unexpectedly stopped, this message provides the reason","readOnly":true},"repeat":{"type":"boolean","description":"indicates if a sequence is to repeat from the beginning after the last campaign completes; default is false","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SignatureDocumentInfo":{"type":"object","properties":{"org":{"readOnly":true,"$ref":"#/definitions/Organization"},"user":{"readOnly":true,"$ref":"#/definitions/User"},"returnUrl":{"type":"string"},"template":{"description":"Template ID alias for the ESignature template you would like to retrieve.","$ref":"#/definitions/DocusignTemplateMapping"}}},"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"}}},"CalibrationAssignment":{"type":"object","properties":{"calibrator":{"$ref":"#/definitions/User"},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"expertEvaluator":{"$ref":"#/definitions/User"}}},"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","TRANSFER_FORWARD","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"},"disconnectedTime":{"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"}}},"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/BillingAddress"},"forRelatedPart":{"type":"string","description":"The part number of a part related to the quote charge."}}},"CampaignSchedule":{"type":"object","required":["campaign","intervals","timeZone"],"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 time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"intervals":{"type":"array","description":"a list of start and end times","items":{"$ref":"#/definitions/ScheduleInterval"}},"timeZone":{"type":"string","example":"Africa/Abidjan","description":"time zone identifier to be applied to the intervals; for example Africa/Abidjan"},"campaign":{"description":"identifier of the campaign to be scheduled","$ref":"#/definitions/UriReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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},"languageDefault":{"type":"boolean","default":false},"tags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"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","inactive","deleted"]},"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}}},"ComposerTemplate":{"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}}},"AnalyticsQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["conversationId","sessionId","mediaType","queueId","userId","participantId","participantName","direction","wrapUpCode","wrapUpNote","interactionType","requestedRoutingSkillId","requestedLanguageId","purpose","participantType","segmentType","disconnectType","errorCode","stationId","edgeId","dnis","ani","outboundCampaignId","outboundContactId","outboundContactListId","monitoredParticipantId","sourceSessionId","destinationSessionId","sourceConversationId","destinationConversationId","remoteNameDisplayable","sipResponseCode","q850ResponseCode","conference","groupId","roomId","addressFrom","addressTo","evaluationId","evaluatorId","contextId","formId","formName","eventTime"]},"propertyType":{"type":"string","description":"Left hand side for property predicates","enum":["bool","integer","real","date","string","uuid"]},"property":{"type":"string","description":"Left hand side for property predicates"},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["tSegmentDuration","oTotalCriticalScore","oTotalScore","nEvaluations","tAbandon","tIvr","tAnswered","tAcd","tTalk","tHeld","tTalkComplete","tHeldComplete","tAcw","tHandle","tWait","tAgentRoutingStatus","tOrganizationPresence","tSystemPresence","tUserResponseTime","tAgentResponseTime","nOffered","nOverSla","nTransferred","nOutboundAttempted","nOutboundConnected","nOutboundAbandoned","nError","oServiceTarget","oServiceLevel","tActive","tInactive","oActiveUsers","oMemberUsers","oActiveQueues","oMemberQueues","oInteracting","oWaiting"]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension, property, or metric predicates"},"range":{"description":"Right hand side for property or metric predicates","$ref":"#/definitions/NumericRange"}}},"DiagnosticEmail":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"subject":{"type":"string","description":"Subject of Issue Report"},"topic":{"type":"string","description":"Functional Area of Issue","enum":["Admin","Documents","Chat","Video Chat","Login","Slowness","Other"]},"description":{"type":"string","description":"Detailed Description of Issue"},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH","CRITICAL"]},"type":{"type":"string","description":"Type of Issue","enum":["Problem","Question","Enhancement Request"]},"data":{"type":"object","description":"Json blob of data to be included with this report."}}},"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"},"disabled":{"type":"boolean","default":false},"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"}}},"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/ComposerTemplate"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TransferRequest":{"type":"object","properties":{"userId":{"type":"string","description":"The user ID of the transfer target."},"address":{"type":"string","description":"The phone number or address of the transfer target."},"userName":{"type":"string","description":"The user name of the transfer target."},"queueId":{"type":"string","description":"The queue ID of the transfer target."},"voicemail":{"type":"boolean","description":"If true, then transfer to the user's voicemail.","default":false}}},"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"}}},"LocationSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string"},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"returnFields":{"type":"array","items":{"type":"string"}},"expand":{"type":"array","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/LocationSearchCriteria"}}}},"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"}}},"AnalyticsQueryClause":{"type":"object","properties":{"type":{"type":"string","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value). These can be one of three types: dimension, property, metric.","items":{"$ref":"#/definitions/AnalyticsQueryPredicate"}}}},"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"},"ChatMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"},"duration":{"$ref":"#/definitions/DurationCondition"}}},"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/UserRoutingSkill"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"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"}}},"DialerContact":{"type":"object","required":["contactListId"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"contactListId":{"type":"string","description":"Identifier of the contact list containing this contact"},"data":{"type":"object","description":"A map of the contact's data attributes and values","additionalProperties":{"type":"object"}},"callRecords":{"type":"object","description":"A map of call records for the contact phone columns","readOnly":true,"additionalProperties":{"$ref":"#/definitions/CallRecord"}},"callable":{"type":"boolean","description":"false if the contact is not to be called","default":false},"phoneNumberStatus":{"type":"object","description":"A map of statuses for the contact phone columns","additionalProperties":{"$ref":"#/definitions/PhoneNumberStatus"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AnalyticsConversationQueryResponse":{"type":"object","properties":{"conversations":{"type":"array","items":{"$ref":"#/definitions/AnalyticsConversation"}},"aggregations":{"type":"array","items":{"$ref":"#/definitions/AggregationResult"}}}},"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 this organization."},"adminUsername":{"type":"string","description":"Administrator username for this organization in the form of an email address."},"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 this 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/BillingAddress"},"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"]}}},"Scene":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"sceneGroup":{"$ref":"#/definitions/SceneGroup"},"assets":{"type":"array","items":{"$ref":"#/definitions/Asset"}},"thumbnail":{"$ref":"#/definitions/Thumbnail"},"description":{"type":"string"},"waypoints":{"type":"array","items":{"$ref":"#/definitions/Waypoint"}},"defaultOrientationY":{"type":"number","format":"double"},"type":{"type":"string","enum":["PRIMARY","SECONDARY"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VideoConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/VideoMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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."},"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"}}},"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","TRANSFER_FORWARD","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"},"disconnectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"SupportCreditListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/SupportCredit"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MediaSetting":{"type":"object","properties":{"alertingTimeoutSeconds":{"type":"integer","format":"int32"},"serviceLevel":{"$ref":"#/definitions/ServiceLevel"}}},"ChatConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/ChatMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"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","required":["types"],"properties":{"sortOrder":{"type":"string","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string"},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"returnFields":{"type":"array","items":{"type":"string"}},"expand":{"type":"array","items":{"type":"string"}},"types":{"type":"array","description":"Resource Domain type","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/SearchCriteria"}},"aggregations":{"type":"array","items":{"$ref":"#/definitions/SearchAggregation"}}}},"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}}},"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"}}},"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","inactive","deleted"]},"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}}},"InitiateScreenRecording":{"type":"object","properties":{"recordACW":{"type":"boolean","default":false},"archiveRetention":{"$ref":"#/definitions/ArchiveRetention"},"deleteRetention":{"$ref":"#/definitions/DeleteRetention"}}},"CreateIntegrationRequest":{"type":"object","required":["integrationType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type."},"integrationType":{"description":"Type of the integration to create.","$ref":"#/definitions/IntegrationType"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details for an Integration"},"AnalyticsProperty":{"type":"object","required":["property","propertyType","value"],"properties":{"propertyType":{"type":"string","description":"Indicates what the data type is (e.g. integer vs string) and therefore how to evaluate what would constitute a match","enum":["bool","integer","real","date","string","uuid"]},"property":{"type":"string","description":"User-defined rather than intrinsic system-observed values. These are tagged onto segments by other components within PureCloud or by API users directly.  This is the name of the user-defined property."},"value":{"type":"string","description":"What property value to match against"}}},"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"}}},"ArchitectAuditMessageListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ArchitectAuditMessage"}},"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}}},"Vpn":{"type":"object","properties":{"type":{"type":"string"},"ip":{"type":"string"},"psk":{"type":"string"}}},"AuditUser":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"display":{"type":"string"}}},"IntegrationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Integration"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GroupSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"startValue":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}},"value":{"type":"string"},"operator":{"type":"string","enum":["AND","OR","NOT"]},"group":{"type":"array","items":{"$ref":"#/definitions/GroupSearchCriteria"}},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS"]}}},"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"},"disabled":{"type":"boolean","default":false},"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","description":"The type of the condition","enum":["wrapupCondition","contactAttributeCondition","phoneNumberCondition","phoneNumberTypeCondition","callAnalysisCondition"]},"inverted":{"type":"boolean","description":"Indicates whether to evaluate for the opposite of the stated condition; default is false","default":false},"attributeName":{"type":"string","description":"An attribute name associated with the condition (applies only to certain rule conditions)"},"value":{"type":"string","description":"A value associated with the condition"},"valueType":{"type":"string","description":"Determines the type of the value associated with the condition","enum":["STRING","NUMERIC","DATETIME","PERIOD"]},"operator":{"type":"string","description":"An operation type for condition evaluation","enum":["EQUALS","LESS_THAN","LESS_THAN_EQUALS","GREATER_THAN","GREATER_THAN_EQUALS","CONTAINS","BEGINS_WITH","ENDS_WITH","BEFORE","AFTER"]},"codes":{"type":"array","description":"List of wrap-up code identifiers (used only in conditions of type 'wrapupCondition')","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"},"languageDefault":{"type":"boolean","default":false},"tags":{"type":"object","additionalProperties":{"type":"array","items":{"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"}}},"RecordingSettings":{"type":"object","properties":{"maxSimultaneousStreams":{"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"}},"includeShares":{"type":"boolean","default":false}}},"AggregationRange":{"type":"object","properties":{"gte":{"type":"number","description":"Greater than or equal to"},"lt":{"type":"number","description":"Less than"}}},"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"}}}},"SceneGroup":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"queue":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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"}}},"AuditFacet":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"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"}},"includeNonAcd":{"type":"boolean","description":"If true, then track non-ACD conversations against utilization","default":false}}},"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}}},"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","inactive","deleted"]},"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}}},"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"}}}},"ContactPhoneNumberColumn":{"type":"object","required":["columnName","type"],"properties":{"columnName":{"type":"string","description":"name of the phone column"},"type":{"type":"string","description":"type of the phone column, for example, 'cell' or 'home'"},"callableTimeColumn":{"type":"string","description":"name of the column indicating the timezone to be considered for determining callable times"}}},"TrunkEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Trunk"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"}}},"SocialMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected on 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 this participant when disconnected on the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"purpose":{"type":"string","description":"The participant's purpose.  Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state.  Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","CONVERTING","UPLOADING","TRANSMITTING","NONE"]},"direction":{"type":"string","description":"The participant's direction.  Values can be: 'inbound' or 'outbound'","enum":["INBOUND","OUTBOUND"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold.","default":false},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up.","default":false},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/UriReference"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/UriReference"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorBody"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/UriReference"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up.","default":false},"socialMediaId":{"type":"string","description":"The social media ID used by this participant."},"socialMediaHub":{"type":"string","description":"The social media hub used by this participant."},"socialUserName":{"type":"string","description":"The social media user name used by this participant."},"previewText":{"type":"string","description":"Some preview text for this participant."}}},"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"}}},"ParticipantAttributes":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"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"}}},"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"}}},"JsonNode":{"type":"object","properties":{"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"float":{"type":"boolean","default":false},"boolean":{"type":"boolean","default":false},"number":{"type":"boolean","default":false},"object":{"type":"boolean","default":false},"valueNode":{"type":"boolean","default":false},"containerNode":{"type":"boolean","default":false},"missingNode":{"type":"boolean","default":false},"pojo":{"type":"boolean","default":false},"integralNumber":{"type":"boolean","default":false},"floatingPointNumber":{"type":"boolean","default":false},"short":{"type":"boolean","default":false},"int":{"type":"boolean","default":false},"long":{"type":"boolean","default":false},"double":{"type":"boolean","default":false},"bigDecimal":{"type":"boolean","default":false},"bigInteger":{"type":"boolean","default":false},"textual":{"type":"boolean","default":false},"binary":{"type":"boolean","default":false},"array":{"type":"boolean","default":false},"null":{"type":"boolean","default":false}}},"SubscriberResponse":{"type":"object","properties":{"messageReturned":{"type":"array","items":{"type":"string"}},"status":{"type":"string"}}},"AuditChange":{"type":"object","properties":{"property":{"type":"string"},"entity":{"$ref":"#/definitions/AuditEntityReference"},"oldValues":{"type":"array","items":{"type":"string"}},"newValues":{"type":"array","items":{"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","inactive","deleted"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"mediaSettings":{"type":"object","additionalProperties":{"$ref":"#/definitions/MediaSetting"}},"bullseye":{"$ref":"#/definitions/Bullseye"},"acwSettings":{"$ref":"#/definitions/AcwSettings"},"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}}},"KeywordSet":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"queue":{"$ref":"#/definitions/Queue"},"language":{"type":"string"},"agents":{"type":"array","items":{"$ref":"#/definitions/User"}},"keywords":{"type":"array","items":{"$ref":"#/definitions/Keyword"}},"participantPurposes":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["AGENT","CUSTOMER"]}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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"}}},"Asset":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"downloadUrl":{"type":"string","format":"url"},"fileSizeBytes":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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","inactive","deleted"]},"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"}},"phoneTrunkBases":{"type":"array","description":"Trunk base settings of trunkType \"PHONE\" to inherit to edge logical interface for phone communication.","items":{"$ref":"#/definitions/UriReference"}},"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"}}},"StatisticalSummary":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"},"count":{"type":"integer","format":"int64"},"sum":{"type":"number"},"current":{"type":"number"},"ratio":{"type":"number"},"numerator":{"type":"number"},"denominator":{"type":"number"},"target":{"type":"number"}}},"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","inactive","deleted"]},"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}}},"SocialConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/SocialMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"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"}}},"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","inactive","deleted"]},"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}}},"CampaignDiagnostics":{"type":"object","properties":{"callableContacts":{"description":"Campaign properties that can impact which contacts are callable","readOnly":true,"$ref":"#/definitions/CallableContactsDiagnostic"},"queueUtilizationDiagnostic":{"description":"Information regarding the campaign's queue","readOnly":true,"$ref":"#/definitions/QueueUtilizationDiagnostic"},"outstandingInteractionsCount":{"type":"integer","format":"int32","description":"Current number of outstanding interactions on the campaign","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"}}}},"AnalyticsSession":{"type":"object","properties":{"mediaType":{"type":"string","enum":["voice","chat","email","callback"]},"sessionId":{"type":"string"},"addressOther":{"type":"string"},"addressSelf":{"type":"string"},"ani":{"type":"string"},"direction":{"type":"string","enum":["inbound","outbound"]},"dnis":{"type":"string"},"outboundCampaignId":{"type":"string"},"outboundContactId":{"type":"string"},"outboundContactListId":{"type":"string"},"dispositionAnalyzer":{"type":"string"},"dispositionName":{"type":"string"},"edgeId":{"type":"string"},"remoteNameDisplayable":{"type":"string"},"roomId":{"type":"string"},"monitoredSessionId":{"type":"string"},"monitoredParticipantId":{"type":"string"},"segments":{"type":"array","items":{"$ref":"#/definitions/AnalyticsConversationSegment"}}}},"Snapshot":{"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}}},"UserSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string"},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"returnFields":{"type":"array","items":{"type":"string"}},"expand":{"type":"array","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/UserSearchCriteria"}}}},"AuthzPermissionContext":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}}},"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"]}}},"UsersSearchResponse":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"previousPage":{"type":"string"},"currentPage":{"type":"string"},"nextPage":{"type":"string"},"types":{"type":"array","items":{"type":"string"}},"results":{"type":"array","items":{"$ref":"#/definitions/User"}},"aggregations":{"type":"array","items":{"$ref":"#/definitions/User"}}}},"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},"description":{"type":"string"},"schema":{"type":"object","additionalProperties":{"type":"object"}}}},"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","description":"The count of unread alerts for a specific rule type."}}},"Trunk":{"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","inactive","deleted"]},"modifiedByApp":{"type":"string"},"createdByApp":{"type":"string"},"trunkType":{"type":"string","description":"The type of this trunk.","enum":["EXTERNAL","PHONE","EDGE"]},"edge":{"description":"The Edge using this trunk.","$ref":"#/definitions/UriReference"},"trunkBase":{"description":"The trunk base configuration used on this trunk.","$ref":"#/definitions/UriReference"},"trunkMetabase":{"description":"The metabase used to create this trunk.","$ref":"#/definitions/UriReference"},"edgeGroup":{"description":"The edge group associated with this trunk.","$ref":"#/definitions/UriReference"},"enabled":{"type":"boolean","description":"True if this trunk is in-service.  This comes from the trunk_enabled property of the referenced trunk base.","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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"}}}},"AuthzGrant":{"type":"object","properties":{"permissionContext":{"$ref":"#/definitions/AuthzPermissionContext"},"role":{"$ref":"#/definitions/AuthzGrantRole"},"grantMadeAt":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"Organization":{"type":"object","required":["version"],"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"},"domain":{"type":"string"},"version":{"type":"integer","format":"int32","description":"The current version of the organization."},"state":{"type":"string","enum":["active","inactive","deleted"]},"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"}}},"EmailMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/EmailMediaPolicyConditions"}}},"SuggestSearchCriteria":{"type":"object","properties":{"endValue":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"startValue":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}},"value":{"type":"string"},"operator":{"type":"string","enum":["AND","OR","NOT"]},"group":{"type":"array","items":{"$ref":"#/definitions/SuggestSearchCriteria"}}}},"InteractionStatsRule":{"type":"object","required":["alertTypes","dimension","dimensionValue","enabled","mediaType","metric","name","notificationUsers","numericRange","statistic","value"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the rule"},"dimension":{"type":"string","description":"The dimension of concern.","enum":["queueId","userId"]},"dimensionValue":{"type":"string","description":"The value of the dimension."},"metric":{"type":"string","description":"The metric to be assessed.","enum":["tAbandon","tAnswered","tTalk","nOffered","tHandle","nTransferred","oServiceLevel","tWait","tHeld","tAcw"]},"mediaType":{"type":"string","description":"The media type.","enum":["voice","chat","email"]},"numericRange":{"type":"string","description":"The comparison descriptor used against the metric's value.","enum":["gt","gte","lt","lte","eq","ne"]},"statistic":{"type":"string","description":"The statistic of concern for the metric.","enum":["count","min","ratio","max"]},"value":{"type":"number","format":"double","description":"The threshold value."},"enabled":{"type":"boolean","description":"Indicates if the rule is enabled.","default":false},"inAlarm":{"type":"boolean","description":"Indicates if the rule is in alarm state.","readOnly":true,"default":false},"notificationUsers":{"type":"array","description":"The ids of users who will be notified of alarm state change.","uniqueItems":true,"items":{"$ref":"#/definitions/User"}},"alertTypes":{"type":"array","description":"A collection of notification methods. = ['SMS', 'DEVICE', 'EMAIL']","uniqueItems":true,"items":{"type":"string","enum":["SMS","DEVICE","EMAIL"]}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SystemPresence":{"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}}},"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","COMMUNICATING"]},"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"},"disabled":{"type":"boolean","default":false},"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"},"CallMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/CallMediaPolicyConditions"}}},"BillingAddress":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"street":{"type":"string"},"city":{"type":"string"},"countryName":{"type":"string"},"stateName":{"type":"string"},"postalCode":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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","inactive","deleted"]},"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"},"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/CallMediaPolicy"},"chatPolicy":{"description":"Conditions and actions for chats","$ref":"#/definitions/ChatMediaPolicy"},"emailPolicy":{"description":"Conditions and actions for emails","$ref":"#/definitions/EmailMediaPolicy"}}},"Usage":{"type":"object","properties":{"types":{"type":"array","items":{"$ref":"#/definitions/UsageItem"}}}},"BatchItemBody":{"type":"object","properties":{"name":{"type":"string"}}},"AnalyticsQueryFilter":{"type":"object","properties":{"type":{"type":"string","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/AnalyticsQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value). These can be one of three types: dimension, property, metric.","items":{"$ref":"#/definitions/AnalyticsQueryPredicate"}}}},"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","required":["columnNames","phoneColumns"],"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 time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"columnNames":{"type":"array","description":"the contact column names","items":{"type":"string"}},"phoneColumns":{"type":"array","description":"the columns containing phone numbers","items":{"$ref":"#/definitions/ContactPhoneNumberColumn"}},"importStatus":{"description":"the status of the import process","readOnly":true,"$ref":"#/definitions/ImportStatus"},"previewModeColumnName":{"type":"string","description":"the name of the column that holds the indicators for contacts that are to be dialed in preview mode only"},"previewModeAcceptedValues":{"type":"array","description":"list of user-defined values indicating the contact is to be dialed in preview mode only","items":{"type":"string"}},"size":{"type":"integer","format":"int64","description":"the number of contacts in the contact list","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BillingContactListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/BillingContact"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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","SUBFLOWCALL"]},"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},"publishStatus":{"type":"string","enum":["STARTED","PENDING_VXMLGEN","PENDING_EDGE_CONFIG","SUCCESS","FAILURE"]},"publishedBy":{"$ref":"#/definitions/UriReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AnalyticsConversation":{"type":"object","properties":{"conversationId":{"type":"string"},"conversationStart":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"participants":{"type":"array","items":{"$ref":"#/definitions/AnalyticsParticipant"}},"evaluations":{"type":"array","items":{"$ref":"#/definitions/AnalyticsEvaluation"}}}},"ChatConversationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ChatConversation"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AuditEntity":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string"}}},"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}}},"UserMe":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"Auto populated from addresses.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"state":{"type":"string","description":"The current state for this user.","readOnly":true,"enum":["active","inactive","deleted"]},"title":{"type":"string"},"username":{"type":"string"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"Required when updating. Version must be the current version. Only the system can assign version.","readOnly":true},"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"},"date":{"description":"The PureCloud system date time.","readOnly":true,"$ref":"#/definitions/ServerDate"},"geolocationSettings":{"description":"Geolocation settings for user's organization.","readOnly":true,"$ref":"#/definitions/GeolocationSettings"},"organization":{"description":"Organization details for this user.","readOnly":true,"$ref":"#/definitions/Organization"},"presenceDefinitions":{"type":"array","description":"The first 100 presence definitions for user's organization.","readOnly":true,"items":{"$ref":"#/definitions/OrganizationPresence"}},"locations":{"type":"array","description":"The first 100 locations for user's organization","readOnly":true,"items":{"$ref":"#/definitions/Location"}},"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."},"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"},"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}}},"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}}},"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"}}}},"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}}},"CallCommand":{"type":"object","properties":{"callNumber":{"type":"string"}}},"BillingPendingTask":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"task":{"$ref":"#/definitions/BillingTaskResult"},"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"}}},"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","TRANSFER_FORWARD","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"},"disconnectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"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"}}},"KeywordSetEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/KeywordSet"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WorkItemSearchDetails":{"type":"object","properties":{"workItem":{"$ref":"#/definitions/WorkItemDetails"}},"description":"WorkItem entry found in result to a search."},"ExternalDataSource":{"type":"object","properties":{"platform":{"type":"string"},"url":{"type":"string"}},"description":"Describes a link to a record in an external system that contributed data to a Relate record"},"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","US_TOLLFREE","XA_TOLLFREE","XB_TOLLFREE","XC_TOLLFREE","AG_DID","AI_DID","BB_DID","BM_DID","BS_DID","CA_DID","DM_DID","DO_DID","GD_DID","JM_DID","KN_DID","KY_DID","KZ_DID","LC_DID","MP_DID","MS_DID","RU_DID","TC_DID","TT_DID","US_DID","VC_DID","VG_DID","AF_DID","AR_DID","AT_DID","AU_DID","BE_DID","BR_DID","CH_DID","CL_DID","CN_DID","CO_DID","CU_DID","DE_DID","DK_DID","EG_DID","ES_DID","FR_DID","GB_DID","GR_DID","HU_DID","ID_DID","IN_DID","IR_DID","IT_DID","JP_DID","KR_DID","LK_DID","MM_DID","MX_DID","MY_DID","NL_DID","NO_DID","NZ_DID","PE_DID","PH_DID","PK_DID","PL_DID","RO_DID","SE_DID","SG_DID","TH_DID","TR_DID","VE_DID","VN_DID","ZA_DID","AD_DID","AE_DID","AL_DID","AM_DID","AO_DID","AQ_DID","AW_DID","AZ_DID","BA_DID","BD_DID","BF_DID","BG_DID","BH_DID","BI_DID","BJ_DID","BL_DID","BN_DID","BO_DID","BQ_DID","BT_DID","BW_DID","BY_DID","BZ_DID","CD_DID","CF_DID","CG_DID","CI_DID","CK_DID","CM_DID","CR_DID","CV_DID","CY_DID","CZ_DID","DJ_DID","DZ_DID","EC_DID","EE_DID","EH_DID","ER_DID","ET_DID","FI_DID","FJ_DID","FK_DID","FM_DID","FO_DID","GA_DID","GE_DID","GF_DID","GH_DID","GI_DID","GL_DID","GM_DID","GN_DID","GP_DID","GQ_DID","GT_DID","GW_DID","GY_DID","HK_DID","HN_DID","HR_DID","HT_DID","IE_DID","IL_DID","IO_DID","IQ_DID","IS_DID","JO_DID","KE_DID","KG_DID","KH_DID","KI_DID","KM_DID","KP_DID","KW_DID","LA_DID","LB_DID","LI_DID","LR_DID","LS_DID","LT_DID","LU_DID","LV_DID","LY_DID","MA_DID","MC_DID","MD_DID","ME_DID","MF_DID","MG_DID","MH_DID","MK_DID","ML_DID","MN_DID","MO_DID","MQ_DID","MR_DID","MT_DID","MU_DID","MV_DID","MW_DID","MZ_DID","NA_DID","NC_DID","NE_DID","NF_DID","NG_DID","NI_DID","NP_DID","NR_DID","NU_DID","OM_DID","PA_DID","PF_DID","PG_DID","PM_DID","PS_DID","PT_DID","PW_DID","PY_DID","QA_DID","RE_DID","RS_DID","RW_DID","SA_DID","SB_DID","SC_DID","SD_DID","SH_247_DID","SH_290_DID","SI_DID","SK_DID","SL_DID","SM_DID","SN_DID","SO_DID","SR_DID","SS_DID","ST_DID","SV_DID","SY_DID","SZ_DID","TD_DID","TG_DID","TJ_DID","TK_DID","TL_DID","TM_DID","TN_DID","TO_DID","TV_DID","TW_DID","TZ_DID","UA_DID","UG_DID","UY_DID","UZ_DID","VU_DID","WF_DID","WS_DID","XG_DID","XN_DID","XV_882_DID","XV_883_DID","YE_DID","YT_DID","ZM_DID","ZW_DID","SX_DID"]}}},"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"}}},"PropertyIndexRequest":{"type":"object","required":["properties"],"properties":{"sessionId":{"type":"string","description":"Attach properties to a segment in the indicated session. Also requires a timestamp."},"timestamp":{"type":"integer","format":"int64","description":"Attach properties to a segment covering a specific point in time. Also requries a sessionId."},"properties":{"type":"array","description":"The list of properties to index","items":{"$ref":"#/definitions/AnalyticsProperty"}}}},"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","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}}},"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"}}},"UsageItem":{"type":"object","properties":{"type":{"type":"string","enum":["RECORDING","FAX","DOCUMENT","ALL"]},"totalDocumentByteCount":{"type":"integer","format":"int64"},"totalDocumentCount":{"type":"integer","format":"int64"}}},"IntegrationConfiguration":{"type":"object","required":["advanced","properties","version"],"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."},"propertiesSchemaUri":{"type":"string","description":"URI for the JSON Schema describing the configuration properties in the properties field.","readOnly":true},"advancedSchemaUri":{"type":"string","description":"URI for the JSON Schema describing the advanced configuration","readOnly":true},"properties":{"type":"object","description":"Key-value configuration settings described by the schema in the propertiesSchemaUri field."},"advanced":{"type":"object","description":"Advanced configuration described by the schema in the advancedSchemaUri field."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Configuration for an Integration"},"SuggestSearchRequest":{"type":"object","required":["types"],"properties":{"types":{"type":"array","description":"Resource Domain type","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/SuggestSearchCriteria"}}}},"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"},"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."}}},"AuthzObject":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"lastModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"permissionContexts":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/AuthzPermissionContext"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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"}},"permissionPolicies":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"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"}}},"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"}}},"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"}}},"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"}}}},"Waypoint":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"targetScene":{"$ref":"#/definitions/Scene"},"rotationY":{"type":"number","format":"double"},"rotationX":{"type":"number","format":"double"},"sceneRotationY":{"type":"number","format":"double"},"distance":{"type":"number","format":"double"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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}}},"CallableContactsDiagnostic":{"type":"object","properties":{"dncLists":{"type":"array","description":"Do not call lists for the campaign","readOnly":true,"items":{"$ref":"#/definitions/UriReference"}},"callableTimeSet":{"description":"Callable time sets for the campaign","readOnly":true,"$ref":"#/definitions/UriReference"},"ruleSets":{"type":"array","description":"Rule sets for the campaign","readOnly":true,"items":{"$ref":"#/definitions/UriReference"}}}},"MemberEntity":{"type":"object","properties":{"id":{"type":"string"}}},"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":{"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"}}},"AnalyticsConversationSegment":{"type":"object","properties":{"segmentStart":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"segmentEnd":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"queueId":{"type":"string"},"wrapUpCode":{"type":"string"},"wrapUpNote":{"type":"string"},"wrapUpTags":{"type":"array","items":{"type":"string"}},"errorCode":{"type":"string"},"disconnectType":{"type":"string","enum":["endpoint","client","system","transfer","error","peer","other","spam","transportFailure","conferenceTransfer","consultTransfer","forwardTransfer"]},"segmentType":{"type":"string","enum":["unknown","alert","system","delay","hold","interact","ivr","dialing","wrapup","voicemail"]},"requestedRoutingUserIds":{"type":"array","items":{"type":"string"}},"requestedRoutingSkillIds":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"requestedLanguageId":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/definitions/AnalyticsProperty"}},"sourceConversationId":{"type":"string"},"destinationConversationId":{"type":"string"},"sourceSessionId":{"type":"string"},"destinationSessionId":{"type":"string"},"sipResponseCodes":{"type":"array","items":{"type":"integer","format":"int64"}},"q850ResponseCodes":{"type":"array","items":{"type":"integer","format":"int64"}},"conference":{"type":"boolean","default":false},"groupId":{"type":"string"},"subject":{"type":"string"}}},"OAuthClient":{"type":"object","required":["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."},"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 and client credential 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"}},"authorizedGrantType":{"type":"string","description":"The OAuth Grant/Client type supported by this client.\nCode Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured.\nImplicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured.\nSAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint.\nClient Credential grant type - Used to created access tokens that are tied only to the client.\n","enum":["CODE","TOKEN","SAML2BEARER","PASSWORD","CLIENT_CREDENTIALS"]},"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":{"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","required":["responses"],"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 time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"responses":{"type":"object","description":"Map of disposition identifiers to reactions. For example: {\"disposition.classification.callable.person\": {\"reactionType\": \"transfer\"}}","additionalProperties":{"$ref":"#/definitions/Reaction"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GreetingAudioFile":{"type":"object","properties":{"durationMilliseconds":{"type":"integer","format":"int64"},"sizeBytes":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri"}}},"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/FlowHistoryDataItem"}},"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"},"MediaParticipantRequest":{"type":"object","properties":{"wrapup":{"description":"Wrap-up to assign to this participant.","$ref":"#/definitions/Wrapup"},"state":{"type":"string","description":"The state to update to set for this participant's communications.  Possible values are: 'connected' and 'disconnected'.","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","CONVERTING","UPLOADING","TRANSMITTING","NONE"]},"recording":{"type":"boolean","description":"True to enable recording of this participant, otherwise false to disable recording.","default":false},"muted":{"type":"boolean","description":"True to mute this conversation participant.","default":false},"confined":{"type":"boolean","description":"True to confine this conversation participant.  Should only be used for ad-hoc conferences","default":false},"held":{"type":"boolean","description":"True to hold this conversation participant.","default":false},"wrapupSkipped":{"type":"boolean","description":"True to skip wrap-up for this participant.","default":false}}},"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","inactive","deleted"]},"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"},"webRtcUser":{"description":"This is the user associated with a WebRTC type phone.  It is required for all WebRTC phones.","$ref":"#/definitions/UriReference"},"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"}}},"UserSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"startValue":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}},"value":{"type":"string"},"operator":{"type":"string","enum":["AND","OR","NOT"]},"group":{"type":"array","items":{"$ref":"#/definitions/UserSearchCriteria"}},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS"]}}},"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."},"AnalyticsParticipant":{"type":"object","properties":{"participantId":{"type":"string"},"participantName":{"type":"string"},"userId":{"type":"string"},"purpose":{"type":"string","enum":["manual","dialer","inbound","acd","ivr","voicemail","outbound","agent","user","station","group","customer","external"]},"sessions":{"type":"array","items":{"$ref":"#/definitions/AnalyticsSession"}}}},"VendorConnectionRequest":{"type":"object","properties":{"publisher":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}},"DeleteRetention":{"type":"object","properties":{"days":{"type":"integer","format":"int32"}}},"Integration":{"type":"object","required":["name","state","version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type."},"integrationType":{"description":"Type of the integration","readOnly":true,"$ref":"#/definitions/IntegrationType"},"state":{"type":"string","description":"Configured state of the integration.","enum":["ENABLED","DISABLED","DELETED"]},"config":{"description":"Configuration for the integration.","readOnly":true,"$ref":"#/definitions/IntegrationConfiguration"},"lastStatus":{"description":"Last reported status of the integration.","readOnly":true,"$ref":"#/definitions/IntegrationStatusInfo"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details for an Integration"},"PresenceQueryResponse":{"type":"object","properties":{"systemToOrganizationMappings":{"type":"object","description":"A mapping from system presence to a list of organization presence ids","additionalProperties":{"type":"array","items":{"type":"string"}}},"results":{"type":"array","items":{"$ref":"#/definitions/AggregateDataContainer"}}}},"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/ContentFilterItem"}},"attributeFilters":{"type":"array","items":{"$ref":"#/definitions/AttributeFilterItem"}},"includeShares":{"type":"boolean","default":false}}},"FaxSummary":{"type":"object","properties":{"readCount":{"type":"integer","format":"int32"},"unreadCount":{"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int32"}}},"CallMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"},"directions":{"type":"array","items":{"type":"string","enum":["INBOUND","OUTBOUND"]}},"duration":{"$ref":"#/definitions/DurationCondition"}}},"AssetEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Scene"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"source":{"type":"string","description":"Represents the source where the Presence was set. Some examples are: PURECLOUD, LYNC, OUTLOOK, etc."},"primary":{"type":"boolean","description":"A boolean used to tell whether or not to set this presence source as the primary on a PATCH","default":false},"presenceDefinition":{"$ref":"#/definitions/OrganizationPresence"},"message":{"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}}},"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"}}},"InteractionStatsAlertContainer":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/InteractionStatsAlert"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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","SCHEDULED","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","TRANSFER_FORWARD","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"},"disconnectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"callbackScheduledTime":{"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}}},"AuthzGrantPolicy":{"type":"object","properties":{"actions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"condition":{"type":"string"},"domain":{"type":"string"},"entityName":{"type":"string"}}},"FlowTerminateRequest":{"type":"object","properties":{"reason":{"type":"string","description":"Reason code for a termination."}},"description":"Passed into a terminate command to customize the termination action."},"PagingSpec":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32","description":"How many results per page"},"pageNumber":{"type":"integer","format":"int32","description":"How many pages in"}}},"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","inactive","deleted"]},"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/SubscriberResponse"}}},"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"}},"description":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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"}}},"CallbackConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/CallbackMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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","required":["error"],"properties":{"error":{"type":"string","description":"name of the error","readOnly":true},"details":{"type":"string","description":"additional information regarding the error","readOnly":true}}},"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}}},"Thumbnail":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"downloadUrl":{"type":"string","format":"url"},"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"}}},"PortBillingAddress":{"type":"object","properties":{"streetAddress":{"type":"string"},"cityProvince":{"type":"string"},"state":{"type":"string"},"zipPostal":{"type":"string"},"country":{"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","inactive","deleted"]},"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}}},"SceneGroupEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/SceneGroup"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Currency":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"decimalPlaces":{"type":"integer","format":"int32"},"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","inactive","deleted"]},"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}}},"LocationAddress":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"countryName":{"type":"string"},"state":{"type":"string"},"street1":{"type":"string"},"street2":{"type":"string"},"zipcode":{"type":"string"}}},"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"}}},"ConversationAssociation":{"type":"object","required":["communicationId","conversationId","mediaType"],"properties":{"conversationId":{"type":"string","description":"Conversation ID"},"communicationId":{"type":"string","description":"Communication ID"},"mediaType":{"type":"string","description":"Media type","enum":["CALL","CALLBACK","CHAT","EMAIL","SOCIAL_EXPRESSION","VIDEO"]}}},"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","required":["campaignId","contactId","contactListId","phoneColumn","schedule"],"properties":{"campaignId":{"type":"string","description":"Campaign identifier"},"contactListId":{"type":"string","description":"Contact list identifier"},"contactId":{"type":"string","description":"Contact identifier"},"phoneColumn":{"type":"string","description":"Name of the phone column containing the number to be called"},"schedule":{"type":"string","description":"The scheduled time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ\", example = \"2016-01-02T16:59:59\""}}},"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"}}},"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","SUBFLOWCALLFLOW","SYSTEMPROMPT","USER","USERPROMPT","VOICEXML"]},"deleted":{"type":"boolean","default":false},"updated":{"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","required":["campaign","contactList"],"properties":{"campaign":{"description":"Identifier of the campaign","$ref":"#/definitions/UriReference"},"contactList":{"description":"Identifier of the contact list","$ref":"#/definitions/UriReference"},"numberOfContactsCalled":{"type":"integer","format":"int64","description":"Number of contacts processed during the campaign","readOnly":true},"totalNumberOfContacts":{"type":"integer","format":"int64","description":"Total number of contacts in the campaign","readOnly":true},"percentage":{"type":"integer","format":"int64","description":"Percentage of contacts processed during the campaign","readOnly":true}}},"DomainNetworkAddress":{"type":"object","properties":{"type":{"type":"string"},"address":{"type":"string"},"persistent":{"type":"boolean","default":false},"family":{"type":"integer","format":"int32"}}},"QueueUtilizationDiagnostic":{"type":"object","properties":{"queue":{"description":"Identifier of the queue","readOnly":true,"$ref":"#/definitions/UriReference"},"usersInQueue":{"type":"integer","format":"int32","description":"The number of users joined to the queue","readOnly":true},"activeUsersInQueue":{"type":"integer","format":"int32","description":"The number of users active on the queue","readOnly":true},"usersOnQueue":{"type":"integer","format":"int32","description":"The number of users with a status of on-queue","readOnly":true},"usersNotUtilized":{"type":"integer","format":"int32","description":"The number of users in the queue currently not engaged","readOnly":true},"usersOnQueueWithStation":{"type":"integer","format":"int32","description":"The number of users in the queue with a station","readOnly":true},"usersOnACampaignCall":{"type":"integer","format":"int32","description":"The number of users currently engaged in a campaign call","readOnly":true},"usersOnDifferentEdgeGroup":{"type":"integer","format":"int32","description":"The number of users whose station is homed to an edge different from the campaign","readOnly":true},"usersOnANonCampaignCall":{"type":"integer","format":"int32","description":"The number of users currently engaged in a communication that is not part of the campaign","readOnly":true}}},"CallConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/CallMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"recordingState":{"type":"string","enum":["NONE","ACTIVE","PAUSED"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmailMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"}}},"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}}},"AuthzPerm":{"type":"object","properties":{"name":{"type":"string"},"permitted":{"type":"boolean","default":false}}},"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","GROUP"]},"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}}},"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"},"externalContactId":{"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},"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/ConversationChat"}},"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"}}}},"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}}},"MediaSummaryDetail":{"type":"object","properties":{"active":{"type":"integer","format":"int32"},"acw":{"type":"integer","format":"int32"}}},"InteractionStatsAlert":{"type":"object","required":["alertTypes","dimension","dimensionValue","mediaType","metric","name","notificationUsers","numericRange","ruleId","startDate","statistic","unread","value"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the rule that generated the alert","readOnly":true},"dimension":{"type":"string","description":"The dimension of concern.","readOnly":true,"enum":["queueId","userId"]},"dimensionValue":{"type":"string","description":"The value of the dimension.","readOnly":true},"metric":{"type":"string","description":"The metric to be assessed.","readOnly":true,"enum":["tAbandon","tAnswered","tTalk","nOffered","tHandle","nTransferred","oServiceLevel","tWait","tHeld","tAcw"]},"mediaType":{"type":"string","description":"The media type.","readOnly":true,"enum":["voice","chat","email"]},"numericRange":{"type":"string","description":"The comparison descriptor used against the metric's value.","readOnly":true,"enum":["gt","gte","lt","lte","eq","ne"]},"statistic":{"type":"string","description":"The statistic of concern for the metric.","readOnly":true,"enum":["count","min","ratio","max"]},"value":{"type":"number","format":"double","description":"The threshold value.","readOnly":true},"ruleId":{"type":"string","description":"The id of the rule.","readOnly":true},"unread":{"type":"boolean","description":"Indicates if the alert has been read.","default":false},"startDate":{"type":"string","format":"date-time","description":"The date/time the alert was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"endDate":{"type":"string","format":"date-time","description":"The date/time the owning rule exiting in alarm status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"notificationUsers":{"type":"array","description":"The ids of users who were notified of alarm state change.","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/User"}},"alertTypes":{"type":"array","description":"A collection of notification methods. = ['SMS', 'DEVICE', 'EMAIL']","readOnly":true,"uniqueItems":true,"items":{"type":"string","enum":["SMS","DEVICE","EMAIL"]}},"ruleUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SequenceSchedule":{"type":"object","required":["intervals","sequence","timeZone"],"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 time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"intervals":{"type":"array","description":"a list of start and end times","items":{"$ref":"#/definitions/ScheduleInterval"}},"timeZone":{"type":"string","example":"Africa/Abidjan","description":"time zone identifier to be applied to the intervals; for example Africa/Abidjan"},"sequence":{"description":"identifier of the sequence to be scheduled","$ref":"#/definitions/UriReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Group":{"type":"object","required":["rulesVisible","type","visibility"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"memberCount":{"type":"integer","format":"int64","description":"Number of members.","readOnly":true},"state":{"type":"string","description":"Active, inactive, or deleted state.","readOnly":true,"enum":["active","inactive","deleted"]},"version":{"type":"integer","format":"int32","description":"Current version for this resource.","readOnly":true},"type":{"type":"string","description":"Type of group.","enum":["social","official"]},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/Contact"}},"rulesVisible":{"type":"boolean","description":"Are membership rules visible to the person requesting to view the group","default":false},"visibility":{"type":"string","description":"Who can view this group","enum":["public","owners","members"]},"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"}}},"AvailableLanguageList":{"type":"object","properties":{"languages":{"type":"array","items":{"type":"string"}}}},"UserImage":{"type":"object","properties":{"resolution":{"type":"string","description":"Height and/or width of image. ex: 640x480 or x128"},"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","required":["callableTimes"],"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 time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"callableTimes":{"type":"array","description":"list of time/timezone groupings for which it is acceptable to place outbound calls","items":{"$ref":"#/definitions/CallableTime"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrunkRecordingEnabledCount":{"type":"object","properties":{"enabledCount":{"type":"integer","format":"int32","description":"The amount of trunks that have recording enabled"},"disabledCount":{"type":"integer","format":"int32","description":"The amount of trunks that do not have recording enabled"}}},"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/ResponseFilter"}}},"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"}}},"SocialConversationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/SocialConversation"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"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"}}},"WaypointEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Waypoint"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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}}},"ChannelTopic":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Topic id for subscription"},"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"}}},"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}}},"CustomerInteractionCenter":{"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"},"disabled":{"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","TRANSFER_FORWARD","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"},"connectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"disconnectedTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"disconnectReasons":{"type":"array","items":{"$ref":"#/definitions/DisconnectReason"}}}},"SupportCredit":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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"]},"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"]}}},"CallbackMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected on 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 this participant when disconnected on the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"purpose":{"type":"string","description":"The participant's purpose.  Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state.  Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","CONVERTING","UPLOADING","TRANSMITTING","NONE"]},"direction":{"type":"string","description":"The participant's direction.  Values can be: 'inbound' or 'outbound'","enum":["INBOUND","OUTBOUND"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold.","default":false},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up.","default":false},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/UriReference"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/UriReference"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorBody"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/UriReference"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up.","default":false},"outboundPreview":{"$ref":"#/definitions/DialerPreview"},"callbackNumbers":{"type":"array","items":{"type":"string"}},"callbackUserName":{"type":"string"},"skipEnabled":{"type":"boolean","default":false},"timeoutSeconds":{"type":"integer","format":"int32"},"callbackScheduledTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"PhonesReboot":{"type":"object","properties":{"phoneIds":{"type":"array","items":{"type":"string"}},"siteId":{"type":"string"}}},"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"}}},"ManagementUnitTimezone":{"type":"object","properties":{"timezone":{"type":"string"}}},"Utilization":{"type":"object","properties":{"utilization":{"type":"object","description":"Map of media types to utilization settings.  Map keys can be: call, chat, email, or socialExpression","additionalProperties":{"$ref":"#/definitions/OrgMediaUtilization"}}}},"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."},"AuthzGrantRole":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"policies":{"type":"array","items":{"$ref":"#/definitions/AuthzGrantPolicy"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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","inactive","deleted"]},"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},"inheritPhoneTrunkBasesIPv4":{"type":"boolean","description":"The IPv4 phone trunk base assignment will be inherited from the Edge Group.","default":false},"inheritPhoneTrunkBasesIPv6":{"type":"boolean","description":"The IPv6 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}}},"FlowSearchRequest":{"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"},"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","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"}}},"CampaignTimeSlot":{"type":"object","required":["day"],"properties":{"startTime":{"type":"string","example":"08:00:00","description":"interval start time as an ISO-8601 string. For example: HH:mm:ss"},"stopTime":{"type":"string","example":"16:59:59","description":"interval stop time as an ISO-8601 string. For example: HH:mm:ss"},"day":{"type":"integer","format":"int32","example":"1","description":"must be within [1-7], representing Monday through Sunday"}}},"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"}}},"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"}}},"TagModel":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"UserStation":{"type":"object","properties":{"id":{"type":"string","description":"A globally unique identifier for this station","readOnly":true},"associatedUser":{"$ref":"#/definitions/User"},"associatedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"defaultUser":{"$ref":"#/definitions/User"},"providerInfo":{"type":"object","description":"Provider-specific info for this station, e.g. { \"edgeGroupId\": \"ffe7b15c-a9cc-4f4c-88f5-781327819a49\" }","additionalProperties":{"type":"string"}}}},"CallRecord":{"type":"object","properties":{"lastAttempt":{"type":"string","format":"date-time","description":"Timestamp of the last attempt to reach this number. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"lastResult":{"type":"string","description":"Result of the last attempt to reach this number","readOnly":true}}},"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"}}},"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":{"description":"Evaluation form used for evaluation.","$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"},"neverRelease":{"type":"boolean","description":"Signifies if the evaluation is never to be released. This cannot be set true if release date is also set.","default":false},"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"}}},"AggregateMetricData":{"type":"object","properties":{"metric":{"type":"string","enum":["tSegmentDuration","oTotalCriticalScore","oTotalScore","nEvaluations","tAbandon","tIvr","tAnswered","tAcd","tTalk","tHeld","tTalkComplete","tHeldComplete","tAcw","tHandle","tWait","tAgentRoutingStatus","tOrganizationPresence","tSystemPresence","tUserResponseTime","tAgentResponseTime","nOffered","nOverSla","nTransferred","nOutboundAttempted","nOutboundConnected","nOutboundAbandoned","nError","oServiceTarget","oServiceLevel","tActive","tInactive","oActiveUsers","oMemberUsers","oActiveQueues","oMemberQueues","oInteracting","oWaiting"]},"qualifier":{"type":"string"},"stats":{"$ref":"#/definitions/StatisticalSummary"}}},"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"}}},"CodesRequest":{"type":"object","properties":{"organizationId":{"type":"string"},"addCommunicationCode":{"type":"string"}}},"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","required":["callAnalysisResponseSet","campaignStatus","contactList","dialingMode","edgeGroup","phoneColumns","queue","script"],"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 time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"contactList":{"description":"identifier of the contact list for the campaign","$ref":"#/definitions/UriReference"},"queue":{"description":"identifier of the agent assignment queue, required for all dialing modes other than agentless","$ref":"#/definitions/UriReference"},"dialingMode":{"type":"string","description":"dialing mode of the campaign","enum":["agentless","preview","power","predictive","progressive"]},"script":{"description":"identifier of the campaign script, required for all dialing modes other than agentless","$ref":"#/definitions/UriReference"},"edgeGroup":{"description":"identifier of the edge group, required for all dialing modes other than preview","$ref":"#/definitions/UriReference"},"campaignStatus":{"type":"string","description":"status of the campaign; can be set to 'on' or 'off'"},"phoneColumns":{"type":"array","description":"the contact list phone columns to be called for the campaign","items":{"$ref":"#/definitions/PhoneColumn"}},"abandonRate":{"type":"number","format":"double","description":"the targeted abandon rate percentage"},"dncLists":{"type":"array","description":"identifiers of the do not call lists","items":{"$ref":"#/definitions/UriReference"}},"callableTimeSet":{"description":"the identifier of the callable time set","$ref":"#/definitions/UriReference"},"callAnalysisResponseSet":{"description":"the identifier of the call analysis response set, required for all dialing modes other than preview","$ref":"#/definitions/UriReference"},"errors":{"type":"array","description":"a list of current error conditions associated with the campaign","readOnly":true,"items":{"$ref":"#/definitions/RestErrorDetail"}},"callerName":{"type":"string","description":"caller id name to be displayed on the outbound call"},"callerAddress":{"type":"string","example":"[phone]","description":"caller id phone number to be displayed on the outbound call"},"outboundLineCount":{"type":"integer","format":"int32","description":"for agentless campaigns, the number of outbound lines to be concurrently dialed"},"ruleSets":{"type":"array","description":"identifiers of the rule sets","items":{"$ref":"#/definitions/UriReference"}},"skipPreviewDisabled":{"type":"boolean","description":"for preview campaigns, indicator of whether the agent can skip a preview without placing a call","default":false},"previewTimeOutSeconds":{"type":"integer","format":"int64","description":"for preview campaigns, number of seconds before a call will be automatically placed. A value of 0 indicates no automatic placement of calls"},"contactSort":{"description":"information determining the order in which the contacts will be dialed","$ref":"#/definitions/ContactSort"},"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.","enum":["text/plain","text/html"]}},"description":"Contains information about the text associated with a response."},"ContentFilterItem":{"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"}}}},"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}}},"ReplaceRequest":{"type":"object","properties":{"changeNumber":{"type":"integer","format":"int32"},"name":{"type":"string"},"authToken":{"type":"string"}}},"ConversationQuery":{"type":"object","properties":{"interval":{"type":"string","description":"Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"conversationFilters":{"type":"array","description":"Filters that target conversation-level data","items":{"$ref":"#/definitions/AnalyticsQueryFilter"}},"evaluationFilters":{"type":"array","description":"Filters that target quality management evaluation-level data","items":{"$ref":"#/definitions/AnalyticsQueryFilter"}},"segmentFilters":{"type":"array","description":"Filters that target individual segments within a conversation","items":{"$ref":"#/definitions/AnalyticsQueryFilter"}},"aggregations":{"type":"array","description":"Include faceted search and aggregate roll-ups describing your search results. This does not function as a filter, but rather, summary data about the data matching your filters","items":{"$ref":"#/definitions/AnalyticsQueryAggregation"}},"paging":{"description":"Page size and number to control iterating through large result sets. Default page size is 25","$ref":"#/definitions/PagingSpec"},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc"]},"orderBy":{"type":"string","description":"Specify which data element within the result set to use for sorting. The options  to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart","enum":["conversationStart","segmentStart","segmentEnd"]}}},"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"},"totalDocumentByteCount":{"type":"integer","format":"int64"}}},"UnreadStatus":{"type":"object","properties":{"unread":{"type":"boolean","description":"Sets if the alert is read or unread.","default":false}}},"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}}},"EdgeLogsJobUploadRequest":{"type":"object","properties":{"fileIds":{"type":"array","items":{"type":"string"}}}},"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","description":"Number of call attempts made","readOnly":true},"connects":{"type":"integer","format":"int64","description":"Number of calls with a live voice detected","readOnly":true},"connectRatio":{"type":"number","format":"double","description":"Ratio of connects to attempts","readOnly":true}}},"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"}}},"StatisticalResponse":{"type":"object","properties":{"interval":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/definitions/AggregateMetricData"}}}},"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"},"disabled":{"type":"boolean","default":false},"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"}}},"CreateCallbackResponse":{"type":"object","required":["callbackIdentifiers","conversation"],"properties":{"conversation":{"description":"The conversation associated with the callback","$ref":"#/definitions/UriReference"},"callbackIdentifiers":{"type":"array","description":"The list of communication identifiers for the callback participants","items":{"$ref":"#/definitions/CallbackIdentifier"}}}},"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","SUBFLOWCALLFLOW","SYSTEMPROMPT","USER","USERPROMPT","VOICEXML"]},"deleted":{"type":"boolean","default":false},"updated":{"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"]},"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","inactive","deleted"]},"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}}},"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"}}},"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"}}}},"LocationSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"startValue":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}},"value":{"type":"string"},"operator":{"type":"string","enum":["AND","OR","NOT"]},"group":{"type":"array","items":{"$ref":"#/definitions/LocationSearchCriteria"}},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS"]}}},"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":{"$ref":"#/definitions/LocationAddress"},"addressVerified":{"type":"boolean","default":false},"emergencyNumber":{"$ref":"#/definitions/LocationEmergencyNumber"},"state":{"type":"string","description":"Current activity status of the location.","enum":["active","deleted"]},"version":{"type":"integer","format":"int32"},"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}}},"ObservationQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/ObservationDataContainer"}}}},"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"},"description":{"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"}}},"ChatMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/ChatMediaPolicyConditions"}}},"VideoConversationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/VideoConversation"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"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."}}},"NumericRange":{"type":"object","properties":{"gt":{"type":"number","description":"Greater than"},"gte":{"type":"number","description":"Greater than or equal to"},"lt":{"type":"number","description":"Less than"},"lte":{"type":"number","description":"Less than or equal to"}}},"CallbackConversationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/CallbackConversation"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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}}},"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"}}},"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}}},"DialerRule":{"type":"object","required":["category","conditions","name"],"properties":{"id":{"type":"string","description":"The identifier of the rule","readOnly":true},"name":{"type":"string","description":"The name of the rule"},"order":{"type":"integer","format":"int32","description":"The ranked order of the rule; rules are processed from lowest number to highest"},"category":{"type":"string","description":"The category of the rule","enum":["DIALER_PRECALL","DIALER_WRAPUP"]},"conditions":{"type":"array","description":"The list of rule conditions; all must evaluate to true to trigger the rule actions","items":{"$ref":"#/definitions/Condition"}},"actions":{"type":"array","description":"The list of rule actions to be taken if the conditions are true","items":{"$ref":"#/definitions/DialerAction"}}}},"SearchAggregation":{"type":"object","properties":{"field":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["COUNT","SUM","AVERAGE","CONTAINS","STARTS_WITH","ENDS_WITH"]},"value":{"type":"string"},"size":{"type":"integer","format":"int32"},"order":{"type":"array","items":{"type":"string","enum":["VALUE_DESC","VALUE_ASC","COUNT_DESC","COUNT_ASC"]}}}},"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"}}},"CreateCallRequest":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"The phone number to dial."},"callFromQueueId":{"type":"string","description":"The queue ID to call on behalf of."},"callQueueId":{"type":"string","description":"The queue ID to call."},"callUserId":{"type":"string","description":"The user ID to call."},"priority":{"type":"integer","format":"int32","description":"The priority to assign to this call (if calling a queue)."},"languageId":{"type":"string","description":"The language skill ID to use for routing this call (if calling a queue)."},"routingSkillsIds":{"type":"array","description":"The skill ID's to use for routing this call (if calling a queue).","items":{"type":"string"}},"conversationIds":{"type":"array","description":"The list of existing call conversations to merge into a new ad-hoc conference.","items":{"type":"string"}},"participants":{"type":"array","description":"The list of participants to call to create a new ad-hoc conference.","items":{"$ref":"#/definitions/Destination"}}}},"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"}}},"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","inactive","deleted"]},"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/AuditFacet"}},"filters":{"type":"array","items":{"$ref":"#/definitions/AuditFilter"}}}},"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","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the integration type."},"name":{"type":"string"},"description":{"type":"string","description":"Localized description of the integration type.","readOnly":true},"provider":{"type":"string","description":"PureCloud provider of the integration type.","readOnly":true},"images":{"type":"array","description":"Collection of logos.","readOnly":true,"items":{"$ref":"#/definitions/UserImage"}},"configPropertiesSchemaUri":{"type":"string","description":"URI of the schema describing the key-value properties needed to configure an integration of this type.","readOnly":true},"configAdvancedSchemaUri":{"type":"string","description":"URI of the schema describing the advanced JSON document needed to configure an integration of this type.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Descriptor for a type of Integration."},"ContactAddress":{"type":"object","properties":{"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"countryCode":{"type":"string"}}},"CallConversationEntityListing":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/CallConversation"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"InteractionStatsRuleContainer":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/InteractionStatsRule"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"}}},"RoutingData":{"type":"object","properties":{"queueId":{"type":"string"},"languageId":{"type":"string"},"priority":{"type":"integer","format":"int32"},"skillIds":{"type":"array","items":{"type":"string"}},"preferredAgentIds":{"type":"array","items":{"type":"string"}}}},"Bullseye":{"type":"object","properties":{"rings":{"type":"array","items":{"$ref":"#/definitions/Ring"}}}},"CallMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected on 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 this participant when disconnected on the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"purpose":{"type":"string","description":"The participant's purpose.  Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state.  Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","CONVERTING","UPLOADING","TRANSMITTING","NONE"]},"direction":{"type":"string","description":"The participant's direction.  Values can be: 'inbound' or 'outbound'","enum":["INBOUND","OUTBOUND"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold.","default":false},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up.","default":false},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/UriReference"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/UriReference"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorBody"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/UriReference"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up.","default":false},"muted":{"type":"boolean","description":"Value is true when the call is muted.","default":false},"confined":{"type":"boolean","description":"Value is true when the call is confined.","default":false},"recording":{"type":"boolean","description":"Value is true when the call is being recorded.","default":false},"recordingState":{"type":"string","description":"The state of the call recording.","enum":["NONE","ACTIVE","PAUSED"]},"group":{"description":"The group involved in the group ring call.","$ref":"#/definitions/UriReference"},"ani":{"type":"string","description":"The call ANI."},"dnis":{"type":"string","description":"The call DNIS."},"documentId":{"type":"string","description":"The ID of the Content Management document if the call is a fax."},"monitoredParticipantId":{"type":"string","description":"The ID of the participant being monitored when performing a call monitor."},"consultParticipantId":{"type":"string","description":"The ID of the consult transfer target participant when performing a consult transfer."}}},"CreateCallbackCommand":{"type":"object","properties":{"scriptId":{"type":"string"},"queueId":{"type":"string"},"routingData":{"$ref":"#/definitions/RoutingData"},"callbackUserName":{"type":"string"},"callbackNumbers":{"type":"array","items":{"type":"string"}},"callbackScheduledTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"countryCode":{"type":"string"},"skipEnabled":{"type":"boolean","default":false},"additionalInfo":{"$ref":"#/definitions/AdditionalInfo"}}},"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}}},"ScheduleInterval":{"type":"object","properties":{"start":{"type":"string","description":"scheduled start time represented as an ISO-8601 string; for example, yyyy-MM-ddTHH:mm:ss.SSSZ"},"end":{"type":"string","description":"scheduled end time represented as an ISO-8601 string; for example, yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"TransformLens":{"type":"object","properties":{"replace":{"type":"string"},"value":{"type":"string"}}},"FlowHistoryDataItem":{"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"},"PhoneNumberStatus":{"type":"object","properties":{"callable":{"type":"boolean","description":"false if the phone number is not callable","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"},"type":{"type":"string"},"lineAppearanceId":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AggregationResult":{"type":"object","properties":{"type":{"type":"string","enum":["termFrequency","numericRange"]},"dimension":{"type":"string","description":"For termFrequency aggregations"},"metric":{"type":"string","description":"For numericRange aggregations"},"count":{"type":"integer","format":"int64"},"results":{"type":"array","items":{"$ref":"#/definitions/AggregationResultEntry"}}}},"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"}}},"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}}},"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}}},"JsonNodeSearchResponse":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"previousPage":{"type":"string"},"currentPage":{"type":"string"},"nextPage":{"type":"string"},"types":{"type":"array","items":{"type":"string"}},"results":{"$ref":"#/definitions/JsonNode"},"aggregations":{"$ref":"#/definitions/JsonNode"}}},"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","inactive","deleted"]},"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/Contact"}},"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"}}},"LocationsSearchResponse":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"previousPage":{"type":"string"},"currentPage":{"type":"string"},"nextPage":{"type":"string"},"types":{"type":"array","items":{"type":"string"}},"results":{"type":"array","items":{"$ref":"#/definitions/Location"}},"aggregations":{"type":"array","items":{"$ref":"#/definitions/Location"}}}},"EstimatedWaitTimePredictions":{"type":"object","required":["results"],"properties":{"results":{"type":"array","description":"Returned upon a successful estimated wait time request.","items":{"$ref":"#/definitions/PredictionResults"}}}},"DncList":{"type":"object","required":["phoneNumberColumns"],"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 time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"phoneNumberColumns":{"type":"array","description":"the name of the columns containing the numbers not to be called","items":{"type":"string"}},"importStatus":{"description":"the status of the import process","readOnly":true,"$ref":"#/definitions/ImportStatus"},"size":{"type":"integer","format":"int64","description":"the number of phone numbers in the do not call list","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateTemplateFromScriptRequestData":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"scriptId":{"type":"string"},"userId":{"type":"string"}}},"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}}},"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"}}},"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."},"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"}}},"Chat":{"type":"object","properties":{"jabberId":{"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","US_TOLLFREE","XA_TOLLFREE","XB_TOLLFREE","XC_TOLLFREE","AG_DID","AI_DID","BB_DID","BM_DID","BS_DID","CA_DID","DM_DID","DO_DID","GD_DID","JM_DID","KN_DID","KY_DID","KZ_DID","LC_DID","MP_DID","MS_DID","RU_DID","TC_DID","TT_DID","US_DID","VC_DID","VG_DID","AF_DID","AR_DID","AT_DID","AU_DID","BE_DID","BR_DID","CH_DID","CL_DID","CN_DID","CO_DID","CU_DID","DE_DID","DK_DID","EG_DID","ES_DID","FR_DID","GB_DID","GR_DID","HU_DID","ID_DID","IN_DID","IR_DID","IT_DID","JP_DID","KR_DID","LK_DID","MM_DID","MX_DID","MY_DID","NL_DID","NO_DID","NZ_DID","PE_DID","PH_DID","PK_DID","PL_DID","RO_DID","SE_DID","SG_DID","TH_DID","TR_DID","VE_DID","VN_DID","ZA_DID","AD_DID","AE_DID","AL_DID","AM_DID","AO_DID","AQ_DID","AW_DID","AZ_DID","BA_DID","BD_DID","BF_DID","BG_DID","BH_DID","BI_DID","BJ_DID","BL_DID","BN_DID","BO_DID","BQ_DID","BT_DID","BW_DID","BY_DID","BZ_DID","CD_DID","CF_DID","CG_DID","CI_DID","CK_DID","CM_DID","CR_DID","CV_DID","CY_DID","CZ_DID","DJ_DID","DZ_DID","EC_DID","EE_DID","EH_DID","ER_DID","ET_DID","FI_DID","FJ_DID","FK_DID","FM_DID","FO_DID","GA_DID","GE_DID","GF_DID","GH_DID","GI_DID","GL_DID","GM_DID","GN_DID","GP_DID","GQ_DID","GT_DID","GW_DID","GY_DID","HK_DID","HN_DID","HR_DID","HT_DID","IE_DID","IL_DID","IO_DID","IQ_DID","IS_DID","JO_DID","KE_DID","KG_DID","KH_DID","KI_DID","KM_DID","KP_DID","KW_DID","LA_DID","LB_DID","LI_DID","LR_DID","LS_DID","LT_DID","LU_DID","LV_DID","LY_DID","MA_DID","MC_DID","MD_DID","ME_DID","MF_DID","MG_DID","MH_DID","MK_DID","ML_DID","MN_DID","MO_DID","MQ_DID","MR_DID","MT_DID","MU_DID","MV_DID","MW_DID","MZ_DID","NA_DID","NC_DID","NE_DID","NF_DID","NG_DID","NI_DID","NP_DID","NR_DID","NU_DID","OM_DID","PA_DID","PF_DID","PG_DID","PM_DID","PS_DID","PT_DID","PW_DID","PY_DID","QA_DID","RE_DID","RS_DID","RW_DID","SA_DID","SB_DID","SC_DID","SD_DID","SH_247_DID","SH_290_DID","SI_DID","SK_DID","SL_DID","SM_DID","SN_DID","SO_DID","SR_DID","SS_DID","ST_DID","SV_DID","SY_DID","SZ_DID","TD_DID","TG_DID","TJ_DID","TK_DID","TL_DID","TM_DID","TN_DID","TO_DID","TV_DID","TW_DID","TZ_DID","UA_DID","UG_DID","UY_DID","UZ_DID","VU_DID","WF_DID","WS_DID","XG_DID","XN_DID","XV_882_DID","XV_883_DID","YE_DID","YT_DID","ZM_DID","ZW_DID","SX_DID"]}}},"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/RoutingSkill"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"BatchCommand":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/BatchItem"}},"commandId":{"type":"string"}}},"ObservationQuery":{"type":"object","properties":{"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/AnalyticsQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *).","items":{"type":"string","enum":["tSegmentDuration","oTotalCriticalScore","oTotalScore","nEvaluations","tAbandon","tIvr","tAnswered","tAcd","tTalk","tHeld","tTalkComplete","tHeldComplete","tAcw","tHandle","tWait","tAgentRoutingStatus","tOrganizationPresence","tSystemPresence","tUserResponseTime","tAgentResponseTime","nOffered","nOverSla","nTransferred","nOutboundAttempted","nOutboundConnected","nOutboundAbandoned","nError","oServiceTarget","oServiceLevel","tActive","tInactive","oActiveUsers","oMemberUsers","oActiveQueues","oMemberQueues","oInteracting","oWaiting"]}}}},"ChatMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected on 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 this participant when disconnected on the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"purpose":{"type":"string","description":"The participant's purpose.  Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state.  Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","CONVERTING","UPLOADING","TRANSMITTING","NONE"]},"direction":{"type":"string","description":"The participant's direction.  Values can be: 'inbound' or 'outbound'","enum":["INBOUND","OUTBOUND"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold.","default":false},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up.","default":false},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/UriReference"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/UriReference"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorBody"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/UriReference"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up.","default":false},"roomId":{"type":"string","description":"The ID of the chat room."}}},"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."},"SharedEntity":{"type":"object","properties":{"id":{"type":"string"}}},"Keyword":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"phrase":{"type":"string"},"confidence":{"type":"integer","format":"int32"},"agentScoreModifier":{"type":"integer","format":"int32"},"customerScoreModifier":{"type":"integer","format":"int32"},"alternateSpellings":{"type":"array","items":{"type":"string"}}}},"CreateShareRequestMember":{"type":"object","properties":{"memberType":{"type":"string","enum":["USER","PUBLIC"]},"member":{"$ref":"#/definitions/MemberEntity"}}},"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/ContactAddress"},"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"},"externalDataSources":{"type":"array","description":"Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record.  Read-only, and only populated when requested via expand param.","readOnly":true,"items":{"$ref":"#/definitions/ExternalDataSource"}},"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}}},"CreateUser":{"type":"object","required":["email","name","password"],"properties":{"name":{"type":"string","description":"User's full name"},"department":{"type":"string"},"email":{"type":"string","description":"User's email and username"},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"title":{"type":"string"},"password":{"type":"string","description":"User's password"}}},"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"}}},"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"}}},"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}}},"PhoneColumn":{"type":"object","required":["columnName","type"],"properties":{"columnName":{"type":"string","description":"name of the phone column"},"type":{"type":"string","description":"type of the phone column, for example, 'cell' or 'home'"}}},"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"}}},"AnalyticsEvaluation":{"type":"object","properties":{"evaluationId":{"type":"string"},"evaluatorId":{"type":"string"},"userId":{"type":"string"},"eventTime":{"type":"string"},"queueId":{"type":"string"},"formId":{"type":"string"},"contextId":{"type":"string"},"formName":{"type":"string"},"getoTotalScore":{"type":"integer","format":"int64"},"getoTotalCriticalScore":{"type":"integer","format":"int64"}}},"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","description":"The type of media that the recording is."},"annotations":{"type":"array","description":"Annotations that belong to the recording.","items":{"$ref":"#/definitions/Annotation"}},"transcript":{"type":"array","description":"Represents a chat transcript","items":{"$ref":"#/definitions/ChatMessage"}},"emailTranscript":{"type":"array","description":"Represents an email transcript","items":{"$ref":"#/definitions/RecordingEmailMessage"}},"fileState":{"type":"string","description":"Represents the current file state for a recording. Examples: Uploading, Archived, etc","enum":["ARCHIVED","AVAILABLE","DELETED","RESTORED","RESTORING","UPLOADING"]},"restoreExpirationTime":{"type":"string","format":"date-time","description":"The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"mediaUris":{"type":"object","description":"The different mediaUris for the recording.","additionalProperties":{"$ref":"#/definitions/MediaResult"}},"estimatedTranscodeTimeMs":{"type":"integer","format":"int64"},"actualTranscodeTimeMs":{"type":"integer","format":"int64"},"archiveDate":{"type":"string","format":"date-time","description":"The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"archiveMedium":{"type":"string","description":"The type of archive medium used. Example: CloudArchive","enum":["CLOUDARCHIVE"]},"deleteDate":{"type":"string","format":"date-time","description":"The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"maxAllowedRestorationsForOrg":{"type":"integer","format":"int32","description":"How many archive restorations the organization is allowed to have."},"remainingRestorationsAllowedForOrg":{"type":"integer","format":"int32","description":"The remaining archive restorations the organization has."},"sessionId":{"type":"string","description":"The session id represents an external resource id, such as email, call, chat, etc"},"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":{"$ref":"#/definitions/MediaSummaryDetail"},"enterprise":{"$ref":"#/definitions/MediaSummaryDetail"}}},"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}}},"AggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"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"}}},"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/ContactAddress"},"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"},"externalDataSources":{"type":"array","description":"Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record.  Read-only, and only populated when requested via expand param.","readOnly":true,"items":{"$ref":"#/definitions/ExternalDataSource"}},"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"}}},"GroupsSearchResponse":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"previousPage":{"type":"string"},"currentPage":{"type":"string"},"nextPage":{"type":"string"},"types":{"type":"array","items":{"type":"string"}},"results":{"type":"array","items":{"$ref":"#/definitions/Group"}},"aggregations":{"type":"array","items":{"$ref":"#/definitions/Group"}}}},"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"}}},"VoicemailMessageEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/VoicemailMessage"}},"selfUri":{"type":"string","format":"uri"}}},"FailedObject":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"name":{"type":"string"},"errorCode":{"type":"string"}}},"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"}}},"GroupMembersUpdate":{"type":"object","properties":{"memberIds":{"type":"array","items":{"type":"string"}},"version":{"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"},"pages":{"type":"array","items":{"$ref":"#/definitions/Page"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AdditionalInfo":{"type":"object"},"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"}}},"GroupSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string"},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"returnFields":{"type":"array","items":{"type":"string"}},"expand":{"type":"array","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/GroupSearchCriteria"}}}},"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","required":["timeZoneId"],"properties":{"timeSlots":{"type":"array","description":"intervals for which it is acceptable to place outbound calls","items":{"$ref":"#/definitions/CampaignTimeSlot"}},"timeZoneId":{"type":"string","example":"Africa/Abidjan","description":"time zone identifier to be applied to the time slots; for example Africa/Abidjan"}}},"AnalyticsQueryAggregation":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["termFrequency","numericRange"]},"dimension":{"type":"string","description":"For use with termFrequency aggregations"},"metric":{"type":"string","description":"For use with numericRange aggregations"},"size":{"type":"integer","format":"int32","description":"For use with termFrequency aggregations"},"ranges":{"type":"array","description":"For use with numericRange aggregations","items":{"$ref":"#/definitions/AggregationRange"}}}},"ImportStatus":{"type":"object","required":["completedRecords","percentComplete","state","totalRecords"],"properties":{"state":{"type":"string","description":"current status of the import","readOnly":true,"enum":["IN_PROGRESS","FAILED"]},"totalRecords":{"type":"integer","format":"int64","description":"total number of records to be imported","readOnly":true},"completedRecords":{"type":"integer","format":"int64","description":"number of records finished importing","readOnly":true},"percentComplete":{"type":"integer","format":"int32","description":"percentage of records finished importing","readOnly":true},"failureReason":{"type":"string","description":"if the import has failed, the reason for the failure","readOnly":true}}},"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"},"cardExpirationDate":{"type":"string","description":"for payment methods of type CARD_TOKEN, the card's expiration date in the format YYYY-MM."},"cardLastFourDigits":{"type":"string"},"cardType":{"type":"string","description":"for payment methods of type CARD_TOKEN, the type of credit or debit card","enum":["Visa","MasterCard","Discover","American Express"]},"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/BillingAddress"}},"selfUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"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"}}},"CreateCallResponse":{"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}}},"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"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"Auto populated from addresses.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"state":{"type":"string","description":"The current state for this user.","readOnly":true,"enum":["active","inactive","deleted"]},"title":{"type":"string"},"username":{"type":"string"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"Required when updating. Version must be the current version. Only the system can assign version.","readOnly":true},"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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"}}},"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"}}}},"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"},"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":{"description":"Information regarding the campaign's connect rate","readOnly":true,"$ref":"#/definitions/ConnectRate"},"idleAgents":{"type":"integer","format":"int32","description":"Number of available agents not currently being utilized","readOnly":true},"adjustedCallsPerAgent":{"type":"number","format":"double","description":"Calls per agent adjusted by pace","readOnly":true},"outstandingCalls":{"type":"integer","format":"int32","description":"Number of campaign calls currently ongoing","readOnly":true}}},"ObservationDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/AggregateMetricData"}}}},"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"}}},"RecordingEmailMessage":{"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"}}},"DomainRole":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the role"},"name":{"type":"string","description":"The name of the role"}}},"DisconnectReason":{"type":"object","properties":{"type":{"type":"string","enum":["Q_850","SIP"]},"code":{"type":"integer","format":"int32"},"phrase":{"type":"string"}}},"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}}},"AggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/AggregateDataContainer"}}}},"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"}}},"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}}},"DomainPermission":{"type":"object","properties":{"domain":{"type":"string"},"entityType":{"type":"string"},"action":{"type":"string"},"label":{"type":"string"},"allowsConditions":{"type":"boolean","default":false}}},"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}}},"VideoMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected on 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 this participant when disconnected on the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"purpose":{"type":"string","description":"The participant's purpose.  Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state.  Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["ALERTING","DIALING","CONTACTING","OFFERING","CONNECTED","DISCONNECTED","TERMINATED","CONVERTING","UPLOADING","TRANSMITTING","NONE"]},"direction":{"type":"string","description":"The participant's direction.  Values can be: 'inbound' or 'outbound'","enum":["INBOUND","OUTBOUND"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["ENDPOINT","CLIENT","SYSTEM","TRANSFER","TRANSFER_CONFERENCE","TRANSFER_CONSULT","ERROR","PEER","OTHER"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold.","default":false},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up.","default":false},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/UriReference"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/UriReference"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorBody"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/UriReference"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up.","default":false},"audioMuted":{"type":"boolean","description":"Value is true when audio is muted.","default":false},"videoMuted":{"type":"boolean","description":"Value is true when video is muted.","default":false},"sharingScreen":{"type":"boolean","description":"Value is true when screen sharing is enabled.","default":false},"peerCount":{"type":"integer","format":"int32","description":"The number of peers of this participant."},"context":{"type":"string","description":"The context for this participant."}}},"NumberOrder":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"did":{"type":"string","description":"DID purchased"},"effectiveStartDate":{"type":"string","format":"date-time","description":"Effective date of service for this order. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"effectiveEndDate":{"type":"string","format":"date-time","description":"Effective disconnection date for this order. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"lastUpdated":{"type":"string","format":"date-time","description":"Date of last update. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"startAuthUserId":{"type":"string","description":"UserId authorizing purchase"},"endAuthUserId":{"type":"string","description":"UserId authorizing disconnection"},"status":{"type":"string","description":"Current status of this DID order","enum":["COMPLETE","CONNECTING","FAILED","BACKORDERED","PENDING","ACTIVATING","ACTIVATION_ERROR","ERROR","DISCONNECTED","DISCONNECT_PENDING","DEACTIVATING","DEACTIVATION_ERROR","DISCONNECT_FAILED","SUBMITTED","REJECTED","SUPP","PORT_PENDING","FOC"]},"phoneNumberType":{"type":"string","description":"Class of DID being purchased (eg. us-domestic, toll-free, etc)","enum":["TOLL_FREE","CN_DOMESTIC","US_DOMESTIC","US_TOLLFREE","XA_TOLLFREE","XB_TOLLFREE","XC_TOLLFREE","AG_DID","AI_DID","BB_DID","BM_DID","BS_DID","CA_DID","DM_DID","DO_DID","GD_DID","JM_DID","KN_DID","KY_DID","KZ_DID","LC_DID","MP_DID","MS_DID","RU_DID","TC_DID","TT_DID","US_DID","VC_DID","VG_DID","AF_DID","AR_DID","AT_DID","AU_DID","BE_DID","BR_DID","CH_DID","CL_DID","CN_DID","CO_DID","CU_DID","DE_DID","DK_DID","EG_DID","ES_DID","FR_DID","GB_DID","GR_DID","HU_DID","ID_DID","IN_DID","IR_DID","IT_DID","JP_DID","KR_DID","LK_DID","MM_DID","MX_DID","MY_DID","NL_DID","NO_DID","NZ_DID","PE_DID","PH_DID","PK_DID","PL_DID","RO_DID","SE_DID","SG_DID","TH_DID","TR_DID","VE_DID","VN_DID","ZA_DID","AD_DID","AE_DID","AL_DID","AM_DID","AO_DID","AQ_DID","AW_DID","AZ_DID","BA_DID","BD_DID","BF_DID","BG_DID","BH_DID","BI_DID","BJ_DID","BL_DID","BN_DID","BO_DID","BQ_DID","BT_DID","BW_DID","BY_DID","BZ_DID","CD_DID","CF_DID","CG_DID","CI_DID","CK_DID","CM_DID","CR_DID","CV_DID","CY_DID","CZ_DID","DJ_DID","DZ_DID","EC_DID","EE_DID","EH_DID","ER_DID","ET_DID","FI_DID","FJ_DID","FK_DID","FM_DID","FO_DID","GA_DID","GE_DID","GF_DID","GH_DID","GI_DID","GL_DID","GM_DID","GN_DID","GP_DID","GQ_DID","GT_DID","GW_DID","GY_DID","HK_DID","HN_DID","HR_DID","HT_DID","IE_DID","IL_DID","IO_DID","IQ_DID","IS_DID","JO_DID","KE_DID","KG_DID","KH_DID","KI_DID","KM_DID","KP_DID","KW_DID","LA_DID","LB_DID","LI_DID","LR_DID","LS_DID","LT_DID","LU_DID","LV_DID","LY_DID","MA_DID","MC_DID","MD_DID","ME_DID","MF_DID","MG_DID","MH_DID","MK_DID","ML_DID","MN_DID","MO_DID","MQ_DID","MR_DID","MT_DID","MU_DID","MV_DID","MW_DID","MZ_DID","NA_DID","NC_DID","NE_DID","NF_DID","NG_DID","NI_DID","NP_DID","NR_DID","NU_DID","OM_DID","PA_DID","PF_DID","PG_DID","PM_DID","PS_DID","PT_DID","PW_DID","PY_DID","QA_DID","RE_DID","RS_DID","RW_DID","SA_DID","SB_DID","SC_DID","SD_DID","SH_247_DID","SH_290_DID","SI_DID","SK_DID","SL_DID","SM_DID","SN_DID","SO_DID","SR_DID","SS_DID","ST_DID","SV_DID","SY_DID","SZ_DID","TD_DID","TG_DID","TJ_DID","TK_DID","TL_DID","TM_DID","TN_DID","TO_DID","TV_DID","TW_DID","TZ_DID","UA_DID","UG_DID","UY_DID","UZ_DID","VU_DID","WF_DID","WS_DID","XG_DID","XN_DID","XV_882_DID","XV_883_DID","YE_DID","YT_DID","ZM_DID","ZW_DID","SX_DID"]},"porting":{"type":"boolean","description":"Whether or not the number was ported","default":false},"billingAddress":{"description":"Billing address used for a number port","$ref":"#/definitions/PortBillingAddress"},"responsibleContact":{"description":"Company contact for a number port","$ref":"#/definitions/PortContact"},"companyName":{"type":"string","description":"Company name for a number port"},"countryCode":{"type":"string","description":"Country dial in codes (telephone dialing prefixes)"},"envelopeId":{"type":"string","description":"Id of the terms and conditions envelope for the order."},"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}}},"Change":{"type":"object","properties":{"entity":{"$ref":"#/definitions/AuditEntity"},"property":{"type":"string"},"oldValues":{"type":"array","items":{"type":"string"}},"newValues":{"type":"array","items":{"type":"string"}}}},"IntegrationStatusInfo":{"type":"object","properties":{"internal":{"type":"string","description":"Machine-readable status as reported by the integration.","readOnly":true,"enum":["ACTIVE","ACTIVATING","INACTIVE","DEACTIVATING","ERROR"]},"effective":{"type":"string","description":"Localized, human-readable, effective status of the integration.","readOnly":true},"detail":{"type":"string","description":"Localized status details for the integration.","readOnly":true},"lastUpdated":{"type":"string","format":"date-time","description":"Date and time (in UTC) when the integration status (i.e. the internal field) was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","readOnly":true}},"description":"Status information for an Integration."},"Contact":{"type":"object","properties":{"address":{"type":"string","description":"Email address or phone number for this contact type"},"display":{"type":"string","description":"Formatted version of the address property","readOnly":true},"mediaType":{"type":"string","enum":["PHONE","EMAIL","SMS"]},"type":{"type":"string","enum":["PRIMARY","WORK","WORK2","WORK3","WORK4","HOME","MOBILE","MAIN"]}}},"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"},"interactionType":{"type":"string","description":"The interaction type for this response.","enum":["chat","email","twitter"]},"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"},"disabled":{"type":"boolean","default":false},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserRoutingSkill":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"proficiency":{"type":"number","format":"double","description":"Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular skill. It is used when a queue is set to \"Best available skills\" mode to allow acd interactions to target agents with higher proficiency ratings."},"state":{"type":"string","description":"Activate or deactivate this routing skill.","enum":["active","inactive","deleted"]},"skillUri":{"type":"string","format":"uri","description":"URI to the organization skill used by this user skill.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id."},"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"}}},"AuthzSubject":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"grants":{"type":"array","items":{"$ref":"#/definitions/AuthzGrant"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PortContact":{"type":"object","properties":{"email":{"type":"string"},"phoneNumber":{"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"}}},"externalDocs":{"description":"PureCloud API Documentation","url":"https://developer.mypurecloud.com"}}
\ No newline at end of file