{
"openapi": "3.0.0",
"info": {
"title": "Webex Wholesale",
"version": "1.0.0",
"description": "The Webex Wholesale APIs are designed for service providers to manage wholesale Webex offerings, including customer onboarding, provisioning, billing, reporting, and lifecycle management. These APIs enable automation and integration with provider systems to deliver scalable, multi-tenant collaboration solutions. Use cases include automated partner onboarding, real-time usage reporting, integration with billing platforms, and management of customer entitlements across large portfolios."
},
"tags": [],
"paths": {
"/wholesale/billing/reports": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WholesaleBillingReportsListResponse"
},
"example": {
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2ZhOA",
"billingStartDate": "2021-05-21",
"billingEndDate": "2021-05-30",
"status": "COMPLETED",
"type": "PARTNER"
},
{
"id": "Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2Zh2B",
"billingStartDate": "2021-05-21",
"billingEndDate": "2021-05-30",
"status": "COMPLETED",
"type": "PARTNER"
},
{
"id": "Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2Zh5D",
"billingStartDate": "2021-05-21",
"billingEndDate": "2021-05-30",
"status": "COMPLETED",
"type": "PARTNER"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Wholesale Billing Reports",
"operationId": "List Wholesale Billing Reports",
"description": "Search for associated wholesale billing reconciliation reports.",
"tags": [
"Wholesale Billing Reports"
],
"parameters": [
{
"name": "billingStartDate",
"in": "query",
"description": "Only include billing reports having this billing `startDate`.",
"example": "2020-05-21",
"schema": {
"type": "string"
}
},
{
"name": "billingEndDate",
"in": "query",
"description": "Only include billing reports having this billing `endDate`.",
"example": "2020-05-30",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Only include reports of this type.",
"example": "PARTNER",
"schema": {
"type": "string",
"enum": [
"PARTNER",
"CUSTOMER",
"USER"
]
}
},
{
"name": "sortBy",
"in": "query",
"description": "Sort the reports.",
"example": "billingStartDate",
"schema": {
"type": "string",
"default": "billingStartDate",
"enum": [
"id",
"billingStartDate",
"billingEndDate",
"status"
]
}
},
{
"name": "status",
"in": "query",
"description": "The status of the billing report",
"example": "COMPLETED",
"schema": {
"type": "string",
"enum": [
"IN_PROGRESS",
"COMPLETED",
"FAILED"
]
}
},
{
"name": "max",
"in": "query",
"description": "Limit the maximum number of reports returned in the response, up to 100 per page. Refer to the [Pagination](/docs/basics#pagination) section of [Webex REST API Basics](/docs/api/basics).",
"example": "10",
"schema": {
"type": "integer",
"default": 100
}
},
{
"name": "subPartnerOrgId",
"in": "query",
"description": "The Organization ID of the sub partner on Cisco Webex.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi81MmNmNTc2ZC02MGE4LTQwN2EtYjIyYy00NjdjNTE1OTE5MDg",
"schema": {
"type": "string"
}
}
]
},
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportId"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2ZhOA",
"billingStartDate": "2021-05-21",
"billingEndDate": "2021-05-30",
"type": "PARTNER",
"internal": true
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Create a Wholesale Billing Report",
"operationId": "Create a Wholesale Billing Report",
"description": "Generate a wholesale billing reconciliation report.",
"tags": [
"Wholesale Billing Reports"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"example": {
"billingStartDate": "2020-05-21",
"billingEndDate": "2020-05-30",
"type": "PARTNER",
"subPartnerOrgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi81MmNmNTc2ZC02MGE4LTQwN2EtYjIyYy00NjdjNTE1OTE5MDg"
},
"schema": {
"type": "object",
"required": [
"billingStartDate",
"billingEndDate"
],
"properties": {
"billingStartDate": {
"type": "string",
"example": "2020-05-21",
"description": "The `startDate` (`YYYY-MM-DD`) for which the partner requests the billing report."
},
"billingEndDate": {
"type": "string",
"example": "2020-05-30",
"description": "The `endDate` (`YYYY-MM-DD`) for which the partner requests the billing report."
},
"type": {
"type": "string",
"example": "PARTNER",
"description": "Create report of the given type, `PARTNER`, `CUSTOMER`, or `USER`. Default: `PARTNER`."
},
"subPartnerOrgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi81MmNmNTc2ZC02MGE4LTQwN2EtYjIyYy00NjdjNTE1OTE5MDg",
"description": "The Organization ID of the sub partner on Cisco Webex."
},
"internal": {
"type": "boolean",
"example": true,
"description": "If true or selected, internal orgs will be included in the billing report. Default: false."
}
}
}
}
}
}
}
},
"/wholesale/billing/reports/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Report"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2ZhOA",
"billingStartDate": "2021-05-21",
"billingEndDate": "2021-05-30",
"type": "PARTNER",
"created": "2021-06-16T12:40:33.109Z",
"createdBy": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wYWNkMzg3NS00ZTEyLTRkNzctYjk4MS1lMzg5ZmQ4ODQ2YzA",
"status": "COMPLETED",
"tempDownloadURL": "https://billing-reports-int-us-east-1.webexcontent.com/a366de9b-3204-4140-8181-25808d360e36/WHOLESALE/340177d1-7f25-41e1-a39f-ad63ec1103a5.csv?Expires=1624978489&Signature=Syp3vrVeMx4P6MeMtm8e1bQaeAdHFe-c7NeHERWh5-qJGLZ1T8Dvl2ee-M8OsFf~z6Yepz94e2Hh1HDVailD0Uryl8SgiM~jl0cBh7L0PmSe~i9oFA0eJ0MulkqGSMVf7ZHhxY55xYMgIBZIERkWm3CqQNDg5BS4EaXapKfOnmFegf36OokCM63m5uOK8-csk08IkZhwo2Z0l1JMtuWYEaLh4dgMHoe~xgH3YmDSSCWInFYaEifUAfgi2YAYS6nP9Zq4BTliBq62XBaehOE1gBrhy4RdwD-3WSs2oD-BdpoRpuGzo3FZzDLVEvd0S2D6gTcHljOHodQKxe-u0BXPWQ__&Key-Pair-Id=APKAJADAKLCI2FW2U32Q"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get a Wholesale Billing Report",
"operationId": "Get a Wholesale Billing Report",
"description": "Retrieve a specific wholesale billing reconciliation report.",
"tags": [
"Wholesale Billing Reports"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "A unique identifier for the report being requested.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2ZhOA",
"schema": {
"type": "string"
}
}
]
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Delete a Wholesale Billing Report",
"operationId": "Delete a Wholesale Billing Report",
"description": "Delete a monthly reconciliation report by report ID.",
"tags": [
"Wholesale Billing Reports"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "A unique report ID that corresponds to a billing report.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2ZhOA",
"schema": {
"type": "string"
}
}
]
}
},
"/wholesale/customers": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerListResponse"
},
"example": {
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4",
"orgId": "Y2lzY29zcGFyazovL3VzL09yZ2FuaXphdGlvbi81MmNmNTc2ZC02MGE4LTQwN2EtYjIyYy00NjdjNTE1OTE5MDk",
"externalId": "c1677a16-557a-4fb4-b48f-24adde57ec99",
"address": {
"addressLine1": "771 Alder Drive",
"addressLine2": "Cisco Site 5",
"city": "Milpitas",
"stateOrProvince": "CA",
"zipOrPostalCode": "95035",
"country": "US"
},
"status": "provisioned_with_errors",
"packages": [
"common_area_calling",
"webex_calling",
"webex_meetings",
"webex_suite",
"webex_voice",
"cx_essentials",
"webex_calling_standard"
],
"resourceDetails": {
"packages": [
{
"name": "common_area_calling",
"status": "provisioned"
},
{
"name": "webex_calling",
"status": "error",
"warnings": [
{
"errorCode": 2560,
"description": "One or more Webex Calling services are unavailable due to maintenance, unable to start provisioning. Consult status.webex.com and retry later."
}
]
},
{
"name": "webex_meetings",
"status": "provisioned"
},
{
"name": "webex_suite",
"status": "provisioned"
},
{
"name": "webex_voice",
"status": "provisioned"
},
{
"name": "cx_essentials",
"status": "provisioned"
},
{
"name": "webex_calling_standard",
"status": "provisioned"
}
]
}
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Wholesale Customers",
"operationId": "List Wholesale Customers",
"description": "Return a list of wholesale customers. There are a number of filter options, which can be combined in a single request.",
"tags": [
"Wholesale Provisioning"
],
"parameters": [
{
"name": "externalId",
"in": "query",
"description": "Customer external ID.",
"example": "c1677a16-557a-4fb4-b48f-24adde57ec99",
"schema": {
"type": "string"
}
},
{
"name": "orgId",
"in": "query",
"description": "The encoded Organization ID for the customer.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi81MmNmNTc2ZC02MGE4LTQwN2EtYjIyYy00NjdjNTE1OTE5MDg",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "Customer API status.",
"example": "provisioned_with_errors",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "provisioned_with_errors"
},
"description": "Customer API status."
}
},
{
"name": "offset",
"in": "query",
"description": "Offset value for implementing pagination.",
"example": "10",
"schema": {
"type": "string"
}
},
{
"name": "max",
"in": "query",
"description": "The maximum number of customers returned in the response.",
"example": "10",
"schema": {
"type": "string"
}
},
{
"name": "onBehalfOfSubPartnerOrgId",
"in": "query",
"description": "The encoded organization ID for the sub partner.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"schema": {
"type": "string"
}
}
]
},
"post": {
"responses": {
"202": {
"description": "Accepted",
"headers": {
"Location": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceURL"
},
"example": {
"url": "https://webexapis.com/v1/wholesale/customers/Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Provision a Wholesale Customer",
"operationId": "Provision a Wholesale Customer",
"description": "Provision a Wholesale customer for Cisco Webex services.\n\nThis API will allow a Service Provider to map the Wholesale customer and assign the required licenses and entitlements for Webex, Calling and Meetings.\n\nThe Wholesale customer provisioning is asynchronous and thus a background task is created when this endpoint is invoked.\n\n**packages Note:**\n\n* `cisco_calling_plan` is dependent on: `common_area_calling`, `webex_calling`, `webex_suite`, `webex_voice`, `cx_essentials`, `webex_calling_standard`\n\n* `attendant_console` is dependent on: `webex_calling`, `webex_suite`, `cx_essentials`\n\n\n After successful invocation of this endpoint a URL will be returned in the `Location` header, which will point to the [Get a Wholesale Customer](/docs/api/v1/wholesale-provisioning/get-a-wholesale-customer) endpoint for this customer.\n
",
"tags": [
"Wholesale Provisioning"
],
"parameters": [
{
"name": "onBehalfOfSubPartnerOrgId",
"in": "query",
"description": "The encoded organization ID for the sub partner.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"provisioningId": "ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2",
"packages": [
"common_area_calling"
],
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi81MmNmNTc2ZC02MGE4LTQwN2EtYjIyYy00NjdjNTE1OTE5MDg",
"externalId": "c1677a16-557a-4fb4-b48f-24adde57ec99",
"address": {
"addressLine1": "\"771 Alder Drive\"",
"addressLine2": "\"Cisco Site 5\"",
"city": "\"Milpitas\"",
"stateOrProvince": "\"CA\"",
"zipOrPostalCode": "\"95035\"",
"country": "\"US\""
},
"customerInfo": {
"name": "\"John's Pizza\"",
"primaryEmail": "\"john.anderson@acme.com\"",
"language": "'en'"
},
"provisioningParameters": {
"calling": {
"location": {
"name": "\"Head Office\"",
"address": {
"addressLine1": "\"771 Alder Drive\"",
"addressLine2": "\"Cisco Site 5\"",
"city": "\"Milpitas\"",
"stateOrProvince": "\"CA\"",
"zipOrPostalCode": "\"95035\"",
"country": "\"US\""
},
"timezone": "\"America/Los_Angeles\"",
"language": "\"en_us\"",
"emergencyLocationIdentifier": "\"95547321\""
}
},
"meetings": {
"timezone": "\"America/Los_Angeles\""
},
"packages": {
"limits": {
"webex_calling": 50,
"common_area_calling": 50,
"webex_meetings": 50,
"webex_suite": 50,
"webex_voice": 50,
"cx_essentials": 50,
"webex_calling_standard": 50,
"attendant_console": 50
}
}
},
"subPartnerAdminEmail": "admin@subpartnerorg.com"
},
"schema": {
"type": "object",
"required": [
"provisioningId",
"packages",
"externalId",
"address"
],
"properties": {
"provisioningId": {
"type": "string",
"example": "ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2",
"description": "This Provisioning ID defines how this customer is to be provisioned for Webex Services.\n\nEach Customer Template will have their own unique Provisioning ID. This ID will be displayed under the chosen Customer Template\non [Webex Control Hub](https://admin.webex.com)."
},
"packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WholesalePackagesCustomer"
},
"description": "The complete list of Webex Wholesale packages to be assigned to the customer."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi81MmNmNTc2ZC02MGE4LTQwN2EtYjIyYy00NjdjNTE1OTE5MDg",
"description": "The organization ID of the enterprise in Webex. Mandatory for existing customers."
},
"externalId": {
"type": "string",
"example": "c1677a16-557a-4fb4-b48f-24adde57ec99",
"description": "External ID of the Wholesale customer."
},
"address": {
"type": "object",
"required": [
"addressLine1",
"city",
"country"
],
"properties": {
"addressLine1": {
"type": "string",
"example": "\"771 Alder Drive\"",
"description": "Address line 1."
},
"addressLine2": {
"type": "string",
"example": "\"Cisco Site 5\"",
"description": "Address line 2."
},
"city": {
"type": "string",
"example": "\"Milpitas\"",
"description": "Customer's city."
},
"stateOrProvince": {
"type": "string",
"example": "\"CA\"",
"description": "State or Province of the customer. This attribute may be required in specific geographies, please refer to address section in the admin guide for more information."
},
"zipOrPostalCode": {
"type": "string",
"example": "\"95035\"",
"description": "Postal/Zip code of the customer. This attribute may be required in specific geographies, please refer to address section in the admin guide for more information."
},
"country": {
"type": "string",
"example": "\"US\"",
"description": "ISO2 country code of the customer size = 2. This attribute is used to determine the default Dial In number for the Webex Meeting Sites. Refer to the Address section of [help page](https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/cloudCollaboration/wholesale_rtm/wbxbw_b_wholesale-rtm-solution-guide/wbxbw_m_overview-of-webex-wholesale.html#Cisco_Reference.dita_7875bb3e-10c0-4214-8173-7845db31c7a6) for more information."
}
},
"description": "Billing Address of the customer. (There is a 50 character limit on each address line)"
},
"customerInfo": {
"type": "object",
"required": [
"name",
"primaryEmail"
],
"properties": {
"name": {
"type": "string",
"example": "\"John's Pizza\"",
"description": "The name of the Wholesale customer. Name cannot include the \"%\" character."
},
"primaryEmail": {
"type": "string",
"example": "\"john.anderson@acme.com\"",
"description": "The primary email address of the customer."
},
"language": {
"type": "string",
"example": "'en'",
"description": "The {ISO-639-1}_{ISO-3166} or {ISO-639-1} locale or language code used as preferred language for organization and Webex Meeting Sites. Refer to the [help page](https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/cloudCollaboration/wholesale_rtm/wbxbw_b_wholesale-rtm-solution-guide/wbxbw_m_overview-of-webex-wholesale.html#Cisco_Reference.dita_deb994cb-9c48-4488-b352-54495c54ba1e) for more information."
}
},
"description": "Mandatory for new customer. Optional if Organization ID is provided."
},
"provisioningParameters": {
"type": "object",
"properties": {
"calling": {
"type": "object",
"required": [
"location"
],
"properties": {
"location": {
"type": "object",
"required": [
"name",
"address",
"timezone",
"language"
],
"properties": {
"name": {
"type": "string",
"example": "\"Head Office\"",
"description": "Name of the wholesale customer office."
},
"address": {
"type": "object",
"required": [
"addressLine1",
"city",
"country"
],
"properties": {
"addressLine1": {
"type": "string",
"example": "\"771 Alder Drive\""
},
"addressLine2": {
"type": "string",
"example": "\"Cisco Site 5\""
},
"city": {
"type": "string",
"example": "\"Milpitas\""
},
"stateOrProvince": {
"type": "string",
"example": "\"CA\"",
"description": "State or Province of the customer in ISO 3166 format. This attribute may be required in specific geographies, please refer to address section in the admin guide for more information."
},
"zipOrPostalCode": {
"type": "string",
"example": "\"95035\"",
"description": "Postal/Zip code of the customer. This attribute may be required in specific geographies, please refer to address section in the admin guide for more information."
},
"country": {
"type": "string",
"example": "\"US\""
}
},
"description": "Address of the wholesale customer. (There is a 50 character limit on each address line)"
},
"timezone": {
"type": "string",
"example": "\"America/Los_Angeles\"",
"description": "Customer timezone for calling package. The full list of supported timezones can be found at [List of Time Zones for Wholesale Provisioning](https://help.webex.com/en-us/article/nuh0amab/List-of-Time-Zones-for-Wholesale-Provisioning)."
},
"language": {
"type": "string",
"example": "\"en_us\"",
"description": "Determine language for all generated emails and voice announcements."
},
"emergencyLocationIdentifier": {
"type": "string",
"example": "\"95547321\"",
"description": "SIP Header for any emergency calls from this location."
}
}
}
},
"description": "Mandatory when provisioning calling packages."
},
"meetings": {
"type": "object",
"properties": {
"timezone": {
"type": "string",
"example": "\"America/Los_Angeles\"",
"description": "Customer timezone for meetings package."
}
}
},
"packages": {
"type": "object",
"properties": {
"limits": {
"type": "object",
"properties": {
"webex_calling": {
"type": "number",
"example": 50
},
"common_area_calling": {
"type": "number",
"example": 50
},
"webex_meetings": {
"type": "number",
"example": 50
},
"webex_suite": {
"type": "number",
"example": 50
},
"webex_voice": {
"type": "number",
"example": 50
},
"cx_essentials": {
"type": "number",
"example": 50
},
"webex_calling_standard": {
"type": "number",
"example": 50
},
"attendant_console": {
"type": "number",
"example": 50
}
},
"description": "Packages followed by their respective limits."
}
}
}
}
},
"subPartnerAdminEmail": {
"type": "string",
"example": "admin@subpartnerorg.com",
"description": "The email of the sub partner organization admin."
}
}
}
}
}
}
}
},
"/wholesale/customers/{customerId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {
"Location": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4",
"orgId": "Y2lzY29zcGFyazovL3VzL09yZ2FuaXphdGlvbi81MmNmNTc2ZC02MGE4LTQwN2EtYjIyYy00NjdjNTE1OTE5MDk",
"externalId": "c1677a16-557a-4fb4-b48f-24adde57ec99",
"address": {
"addressLine1": "771 Alder Drive",
"addressLine2": "Cisco Site 5",
"city": "Milpitas",
"stateOrProvince": "CA",
"zipOrPostalCode": "95035",
"country": "US"
},
"status": "provisioned",
"packages": [
"webex_calling"
],
"resourceDetails": {
"packages": [
{
"name": "webex_calling",
"status": "provisioned",
"warnings": [
{
"errorCode": 2560,
"description": "One or more Webex Calling services are unavailable due to maintenance, unable to start provisioning. Consult status.webex.com and retry later."
}
],
"licenseIds": [
"Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvYjdjNGRlZTgtODZmNi00YzAxLWJkYjMtMTM3MjM2ZWY3NGRmOlNMV0NBXzdmYTBkZjhjLTlmNTEtNGE1Zi05YzY4LTU1ODRlNWM2N2E0Yg"
]
}
]
}
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get a Wholesale Customer",
"operationId": "Get a Wholesale Customer",
"description": "Retrieves details of a provisioned Wholesale customer on Cisco Webex.",
"tags": [
"Wholesale Provisioning"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "A unique identifier for the customer in question.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4",
"schema": {
"type": "string"
}
},
{
"name": "onBehalfOfSubPartnerOrgId",
"in": "query",
"description": "The encoded organization ID for the sub partner.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"schema": {
"type": "string"
}
},
{
"name": "includePackageLicenseInfo",
"in": "query",
"description": "If specified as true, a list of licenseIds will be returned for all provisioned packages",
"example": "true",
"schema": {
"type": "boolean"
}
}
]
},
"put": {
"responses": {
"202": {
"description": "Accepted",
"headers": {
"Location": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceURL"
},
"example": {
"url": "https://webexapis.com/v1/wholesale/customers/Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Update a Wholesale Customer",
"operationId": "Update a Wholesale Customer",
"description": "Updates certain details of a provisioned Wholesale customer for Cisco Webex services.\n\nThe Wholesale customer provisioning is asynchronous and thus a background task is created when this endpoint is invoked.\n\n**packages Note:**\n\n* `cisco_calling_plan` is dependent on: `common_area_calling`, `webex_calling`, `webex_suite`, `webex_voice`, `cx_essentials`, `webex_calling_standard`\n\n* `attendant_console` is dependent on: `webex_calling`, `webex_suite`, `cx_essentials`\n\n\n After successful invocation of this endpoint a URL will be returned in the `Location` header, which will point to the [Get a Wholesale Customer](/docs/api/v1/wholesale-provisioning/get-a-wholesale-customer) endpoint for this customer.\n
",
"tags": [
"Wholesale Provisioning"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "A unique identifier for the customer to be updated.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4",
"schema": {
"type": "string"
}
},
{
"name": "onBehalfOfSubPartnerOrgId",
"in": "query",
"description": "The encoded organization ID for the sub partner.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"externalId": "c1677a16-557a-4fb4-b48f-24adde57ec99",
"packages": [
"common_area_calling"
],
"address": {
"addressLine1": "\"771 Alder Drive\"",
"addressLine2": "\"Cisco Site 5\"",
"city": "\"Milpitas\"",
"stateOrProvince": "\"CA\"",
"zipOrPostalCode": "\"95035\"",
"country": "\"US\""
},
"provisioningParameters": {
"calling": {
"location": {
"name": "\"Head Office\"",
"address": {
"addressLine1": "\"771 Alder Drive\"",
"addressLine2": "\"Cisco Site 5\"",
"city": "\"Milpitas\"",
"stateOrProvince": "\"CA\"",
"zipOrPostalCode": "\"95035\"",
"country": "\"US\""
},
"timezone": "\"America/Los_Angeles\"",
"language": "\"en_us\"",
"emergencyLocationIdentifier": "\"95547321\""
}
},
"meetings": {
"timezone": "\"America/Los_Angeles\""
},
"packages": {
"limits": {
"webex_calling": 50,
"common_area_calling": 50,
"webex_meetings": 50,
"webex_suite": 50,
"webex_voice": 50,
"cx_essentials": 50,
"webex_calling_standard": 50,
"attendant_console": 50
}
}
},
"subPartnerAdminEmail": "admin@subpartnerorg.com"
},
"schema": {
"type": "object",
"required": [
"packages"
],
"properties": {
"externalId": {
"type": "string",
"example": "c1677a16-557a-4fb4-b48f-24adde57ec99",
"description": "External ID of the Wholesale customer."
},
"packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WholesalePackagesCustomer"
},
"description": "The complete list of Webex Wholesale packages to be assigned to the customer, including any packages already provisioned. If a package has already been assigned to this customer and is not present in this list, then that package is removed."
},
"address": {
"type": "object",
"required": [
"addressLine1",
"city",
"country"
],
"properties": {
"addressLine1": {
"type": "string",
"example": "\"771 Alder Drive\"",
"description": "Address line 1."
},
"addressLine2": {
"type": "string",
"example": "\"Cisco Site 5\"",
"description": "Address line 2."
},
"city": {
"type": "string",
"example": "\"Milpitas\"",
"description": "Customer's city."
},
"stateOrProvince": {
"type": "string",
"example": "\"CA\"",
"description": "State or Province of the customer. This attribute may be required in specific geographies, please refer to address section in the admin guide for more information."
},
"zipOrPostalCode": {
"type": "string",
"example": "\"95035\"",
"description": "Postal/Zip code of the customer. This attribute may be required in specific geographies, please refer to address section in the admin guide for more information."
},
"country": {
"type": "string",
"example": "\"US\"",
"description": "ISO2 country code of the customer size = 2."
}
},
"description": "Billing Address of the customer. (There is a 50 character limit on each address line)"
},
"provisioningParameters": {
"type": "object",
"properties": {
"calling": {
"type": "object",
"required": [
"location"
],
"properties": {
"location": {
"type": "object",
"required": [
"name",
"address",
"timezone",
"language"
],
"properties": {
"name": {
"type": "string",
"example": "\"Head Office\"",
"description": "Name of the wholesale customer office."
},
"address": {
"type": "object",
"required": [
"addressLine1",
"city",
"country"
],
"properties": {
"addressLine1": {
"type": "string",
"example": "\"771 Alder Drive\""
},
"addressLine2": {
"type": "string",
"example": "\"Cisco Site 5\""
},
"city": {
"type": "string",
"example": "\"Milpitas\""
},
"stateOrProvince": {
"type": "string",
"example": "\"CA\"",
"description": "State or Province of the customer in ISO 3166 format. This attribute may be required in specific geographies, please refer to address section in the admin guide for more information."
},
"zipOrPostalCode": {
"type": "string",
"example": "\"95035\"",
"description": "Postal/Zip code of the customer. This attribute may be required in specific geographies, please refer to address section in the admin guide for more information."
},
"country": {
"type": "string",
"example": "\"US\""
}
},
"description": "Address of the wholesale customer. (There is a 50 character limit on each address line)"
},
"timezone": {
"type": "string",
"example": "\"America/Los_Angeles\"",
"description": "Customer timezone for calling package. The full list of supported timezones can be found at [List of Time Zones for Wholesale Provisioning](https://help.webex.com/en-us/article/nuh0amab/List-of-Time-Zones-for-Wholesale-Provisioning)."
},
"language": {
"type": "string",
"example": "\"en_us\"",
"description": "Determine language for all generated emails and voice announcements."
},
"emergencyLocationIdentifier": {
"type": "string",
"example": "\"95547321\"",
"description": "SIP Header for any emergency calls from this location."
}
}
}
}
},
"meetings": {
"type": "object",
"properties": {
"timezone": {
"type": "string",
"example": "\"America/Los_Angeles\"",
"description": "Customer timezone for meetings package."
}
}
},
"packages": {
"type": "object",
"properties": {
"limits": {
"type": "object",
"properties": {
"webex_calling": {
"type": "number",
"example": 50
},
"common_area_calling": {
"type": "number",
"example": 50
},
"webex_meetings": {
"type": "number",
"example": 50
},
"webex_suite": {
"type": "number",
"example": 50
},
"webex_voice": {
"type": "number",
"example": 50
},
"cx_essentials": {
"type": "number",
"example": 50
},
"webex_calling_standard": {
"type": "number",
"example": 50
},
"attendant_console": {
"type": "number",
"example": 50
}
},
"description": "Packages followed by their respective limits."
}
}
}
},
"description": "Provisioning parameters are required when updating an existing package."
},
"subPartnerAdminEmail": {
"type": "string",
"example": "admin@subpartnerorg.com",
"description": "The email of the sub partner organization admin."
}
}
}
}
}
}
},
"delete": {
"responses": {
"202": {
"description": "Accepted",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Remove a Wholesale Customer",
"operationId": "Remove a Wholesale Customer",
"description": "Removes the mapping between a Wholesale Customer and a Cisco Webex organization..",
"tags": [
"Wholesale Provisioning"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "A unique identifier for the customer in question.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4",
"schema": {
"type": "string"
}
},
{
"name": "onBehalfOfSubPartnerOrgId",
"in": "query",
"description": "The encoded organization ID for the sub partner.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"schema": {
"type": "string"
}
}
]
}
},
"/wholesale/customers/validate": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerProvisioningPrecheckResponse"
},
"example": {
"message": "success",
"info": [
{
"infoCode": 100,
"description": "Provisioning preCheck validation successful."
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Precheck a Wholesale Customer Provisioning",
"operationId": "Precheck a Wholesale Customer Provisioning",
"description": "Allows the Partner sales team to verify likely success of provisioning a Wholesale customer.\n\n**packages Note:**\n\n* `cisco_calling_plan` is dependent on: `common_area_calling`, `webex_calling`, `webex_suite`, `webex_voice`, `cx_essentials`, `webex_calling_standard`\n\n* `attendant_console` is dependent on: `webex_calling`, `webex_suite`, `cx_essentials`\n\n\n\nThe Prerequisite for using this API is to have `wxc-wholesale` entitlement or `webex-wholesale-partner-testing` setting enabled for the Partner Organization. The Provisioning Precheck APIs supports two variants of Wholesale Customer Provisioning Precheck Requests. Please refer to [Using the Provisioning Precheck APIs](/docs/api/guides/webex-for-wholesale#using-the-precheck-provisioning-api) section in [Webex for Wholesale](/docs/api/guides/webex-for-wholesale) guide for more information.\n\n
",
"tags": [
"Wholesale Provisioning"
],
"parameters": [
{
"name": "onBehalfOfSubPartnerOrgId",
"in": "query",
"description": "The encoded organization ID for the sub partner.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"address": {
"addressLine1": "771 Alder Drive",
"addressLine2": "Cisco Site 5",
"city": "Milpitas",
"stateOrProvince": "CA",
"zipOrPostalCode": "95035",
"country": "US"
},
"customerInfo": {
"primaryEmail": "john.anderson@acme.com"
}
},
"schema": {
"type": "object",
"required": [
"address"
],
"properties": {
"provisioningId": {
"type": "string",
"example": "ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2",
"description": "Defines how this wholesale customer is to be provisioned for Cisco Webex Services.\n\nEach Customer Template will have its unique Provisioning ID. This ID will be displayed under the chosen Customer Template\non Cisco Webex Control Hub."
},
"packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WholesalePackagesCustomer"
},
"description": "The complete list of Webex Wholesale packages to be assigned to the Wholesale customer."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi81MmNmNTc2ZC02MGE4LTQwN2EtYjIyYy00NjdjNTE1OTE5MDg",
"description": "The organization ID of the enterprise in Cisco Webex."
},
"externalId": {
"type": "string",
"example": "c1677a16-557a-4fb4-b48f-24adde57ec99",
"description": "External ID of the Wholesale customer."
},
"address": {
"type": "object",
"required": [
"addressLine1",
"city",
"country"
],
"properties": {
"addressLine1": {
"type": "string",
"example": "\"771 Alder Drive\"",
"description": "Address line 1."
},
"addressLine2": {
"type": "string",
"example": "\"Cisco Site 5\"",
"description": "Address line 2."
},
"city": {
"type": "string",
"example": "\"Milpitas\"",
"description": "Customer's city."
},
"stateOrProvince": {
"type": "string",
"example": "\"CA\"",
"description": "State or Province of the Wholesale customer. This attribute may be required in specific geographies. Please refer to [Wholesale Customer Address Requirement](/docs/api/guides/webex-for-wholesale#wholesale-customer-address-requirement) for more information."
},
"zipOrPostalCode": {
"type": "string",
"example": "\"95035\"",
"description": "Postal/Zip code of the Wholesale customer. This attribute may be required in specific geographies. Please refer to [Wholesale Customer Address Requirement](/docs/api/guides/webex-for-wholesale#wholesale-customer-address-requirement) for more information."
},
"country": {
"type": "string",
"example": "\"US\"",
"description": "ISO2 country code of the Wholesale customer size = 2."
}
},
"description": "Billing address of the Wholesale customer. (There is a 50 character limit on each address line)"
},
"customerInfo": {
"type": "object",
"required": [
"primaryEmail"
],
"properties": {
"name": {
"type": "string",
"example": "\"John's Pizza\"",
"description": "The name of the Wholesale customer."
},
"primaryEmail": {
"type": "string",
"example": "\"john.anderson@acme.com\"",
"description": "The primary email address of the Wholesale customer."
}
}
},
"provisioningParameters": {
"type": "object",
"properties": {
"calling": {
"type": "object",
"required": [
"location"
],
"properties": {
"location": {
"type": "object",
"required": [
"name",
"address",
"timezone",
"language"
],
"properties": {
"name": {
"type": "string",
"example": "\"Head Office\"",
"description": "Name of the wholesale customer office."
},
"address": {
"type": "object",
"required": [
"addressLine1",
"city",
"country"
],
"properties": {
"addressLine1": {
"type": "string",
"example": "\"771 Alder Drive\""
},
"addressLine2": {
"type": "string",
"example": "\"Cisco Site 5\""
},
"city": {
"type": "string",
"example": "\"Milpitas\""
},
"stateOrProvince": {
"type": "string",
"example": "\"CA\"",
"description": "State or Province of the Wholesale customer in ISO 3166 format. This attribute may be required in specific geographies. Please refer to [Wholesale Customer Address Requirement](/docs/api/guides/webex-for-wholesale#wholesale-customer-address-requirement) for more information."
},
"zipOrPostalCode": {
"type": "string",
"example": "\"95035\"",
"description": "Postal/Zip code of the Wholesale customer. This attribute may be required in specific geographies. Please refer to [Wholesale Customer Address Requirement](/docs/api/guides/webex-for-wholesale#wholesale-customer-address-requirement) for more information."
},
"country": {
"type": "string",
"example": "\"US\""
}
},
"description": "Address of the wholesale customer.(There is a 50 character limit on each address line)"
},
"timezone": {
"type": "string",
"example": "\"America/Los_Angeles\"",
"description": "Customer timezone for calling package. The full list of supported timezones can be found at [List of Time Zones for Wholesale Provisioning](https://help.webex.com/en-us/article/nuh0amab/List-of-Time-Zones-for-Wholesale-Provisioning)."
},
"language": {
"type": "string",
"example": "\"en_us\"",
"description": "Determine language for all generated emails and voice announcements."
},
"emergencyLocationIdentifier": {
"type": "string",
"example": "\"95547321\"",
"description": "SIP Header for any emergency calls from this location."
}
}
}
}
},
"meetings": {
"type": "object",
"properties": {
"timezone": {
"type": "string",
"example": "\"America/Los_Angeles\"",
"description": "Wholesale Customer timezone for meetings package."
}
}
},
"packages": {
"type": "object",
"properties": {
"limits": {
"type": "object",
"properties": {
"webex_calling": {
"type": "number",
"example": 50
},
"common_area_calling": {
"type": "number",
"example": 50
},
"webex_meetings": {
"type": "number",
"example": 50
},
"webex_suite": {
"type": "number",
"example": 50
},
"webex_voice": {
"type": "number",
"example": 50
},
"cx_essentials": {
"type": "number",
"example": 50
},
"webex_calling_standard": {
"type": "number",
"example": 50
},
"attendant_console": {
"type": "number",
"example": 50
}
},
"description": "Packages followed by their respective limits."
}
}
}
}
}
}
}
}
}
}
}
},
"/wholesale/subPartners": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubPartnersListResponse"
},
"example": {
"subPartners": [
{
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"subscriptionId": "Sub23452345",
"provisioningState": "active",
"created": "2023-02-16T14:10:18.855Z",
"billingStartDate": "2023-02-22T13:43:41.117Z"
},
{
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xNmY5MzE2ZC02OWI0LTQ2MDMtYTQ5YS0zOTIyYzUxMGQ1YWQ",
"subscriptionId": "Sub23452345",
"provisioningState": "active",
"created": "2023-02-16T14:10:18.855Z",
"billingStartDate": "2023-02-22T13:43:41.117Z"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Wholesale Sub-partners",
"operationId": "List Wholesale Sub-partners",
"description": "Lists all of the associated sub-partners. There are a number of filter and pagination options that can be combined in a single request.",
"tags": [
"Wholesale Provisioning"
],
"parameters": [
{
"name": "provisioningState",
"in": "query",
"description": "Status to filter sub-partners based on provisioning state.",
"example": "active",
"schema": {
"type": "string"
}
},
{
"name": "offset",
"in": "query",
"description": "Offset value for implementing pagination.",
"example": "10",
"schema": {
"type": "string"
}
},
{
"name": "max",
"in": "query",
"description": "The maximum number of sub-partners returned in the response.",
"example": "10",
"schema": {
"type": "string"
}
}
]
}
},
"/wholesale/subscribers": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriberListResponse"
},
"example": {
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2",
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"email": "johnandersen@acme.com",
"package": "webex_calling",
"customerId": "Y2lzY29zcGFyazovL3VzL0NVU1RPTUVSL2Y1YjM2MTg3LWM4ZGQtNDcyNy04YjJmLWY5YzQ0N2YyOTA0Ng==",
"externalCustomerId": "c1677a16-557a-4fb4-b48f-24adde57ec99",
"status": "provisioned",
"lastStatusChange": "2021-08-06T02:05:41.791232Z",
"created": "2021-08-06T02:03:00.062Z",
"packages": [
"webex_calling"
]
},
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"email": "johnandersen@acme.com",
"customerId": "Y2lzY29zcGFyazovL3VzL0NVU1RPTUVSL2Y1YjM2MTg3LWM4ZGQtNDcyNy04YjJmLWY5YzQ0N2YyOTA0Ng==",
"externalCustomerId": "c1677a16-557a-4fb4-b48f-24adde57ec99",
"package": "webex_meetings",
"status": "provisioned",
"lastStatusChange": "2021-08-06T02:05:41.791232Z",
"created": "2021-08-06T02:03:00.062Z",
"packages": [
"webex_meetings"
]
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Wholesale Subscribers",
"operationId": "List Wholesale Subscribers",
"description": "Allows a Service Provider to search for their associated subscribers. There are a number of filter options, which can be combined in a single request.",
"tags": [
"Wholesale Provisioning"
],
"parameters": [
{
"name": "max",
"in": "query",
"description": "Limit the maximum number of subscribers returned in the search response, up to 100 per page. Refer to the [Pagination](/docs/basics#pagination) section of [Webex REST API Basics](/docs/api/basics).",
"example": "10",
"schema": {
"type": "integer",
"default": 50
}
},
{
"name": "offset",
"in": "query",
"description": "Offset value to implement [pagination](/docs/basics#pagination).",
"example": "4",
"schema": {
"type": "integer"
}
},
{
"name": "customerId",
"in": "query",
"description": "Wholesale customer ID.",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"schema": {
"type": "string"
}
},
{
"name": "personId",
"in": "query",
"description": "The person ID of the subscriber used in the [/v1/people API](/docs/api/v1/people).",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"schema": {
"type": "string"
}
},
{
"name": "externalCustomerId",
"in": "query",
"description": "Customer external ID.",
"example": "c1677a16-557a-4fb4-b48f-24adde57ec99",
"schema": {
"type": "string"
}
},
{
"name": "email",
"in": "query",
"description": "The email address of the subscriber.",
"example": "john.anderson@acme.com",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "The provisioning status of the subscriber.",
"example": "provisioned",
"schema": {
"type": "string"
}
},
{
"name": "after",
"in": "query",
"description": "Only include subscribers created after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted.",
"example": "1579046400245",
"schema": {
"type": "string"
}
},
{
"name": "lastStatusChange",
"in": "query",
"description": "Only include subscribers with a provisioning status change after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted.",
"example": "1579046400245",
"schema": {
"type": "string"
}
},
{
"name": "sortBy",
"in": "query",
"description": "Supported `sortBy` attributes are `created` and `lastStatusChange`. Default is `created`.",
"example": "userCreationTimestamp",
"schema": {
"type": "string"
}
},
{
"name": "sortOrder",
"in": "query",
"description": "Sort by `ASC` (ascending) or `DESC` (descending).",
"example": "ASC",
"schema": {
"type": "string"
}
},
{
"name": "onBehalfOfSubPartnerOrgId",
"in": "query",
"description": "The encoded organization ID for the sub partner.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"schema": {
"type": "string"
}
}
]
},
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {
"Location": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscriber"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"email": "johnandersen@acme.com",
"customerId": "Y2lzY29zcGFyazovL3VzL0NVU1RPTUVSL2Y1YjM2MTg3LWM4ZGQtNDcyNy04YjJmLWY5YzQ0N2YyOTA0Ng",
"externalCustomerId": "c1677a16-557a-4fb4-b48f-24adde57ec99",
"package": "webex_calling",
"status": "provisioned",
"lastStatusChange": "2021-08-06T02:05:41.791232Z",
"created": "2021-08-06T02:03:00.062Z",
"packages": [
"webex_calling"
]
}
}
}
},
"202": {
"description": "Accepted (returned if an active free account is found, and requires consent based flow to onboard)",
"headers": {
"Location": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscriber"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"email": "johnandersen@acme.com",
"customerId": "Y2lzY29zcGFyazovL3VzL0NVU1RPTUVSL2Y1YjM2MTg3LWM4ZGQtNDcyNy04YjJmLWY5YzQ0N2YyOTA0Ng",
"externalCustomerId": "c1677a16-557a-4fb4-b48f-24adde57ec99",
"package": "webex_calling",
"status": "pending_user_migration",
"lastStatusChange": "2021-08-06T02:05:41.791232Z",
"created": "2021-08-06T02:03:00.062Z",
"packages": [
"webex_calling"
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Provision a Wholesale Subscriber",
"operationId": "Provision a Wholesale Subscriber",
"description": "Provision a new Wholesale subscriber for Cisco Webex services.\n\nThis API allows a Service Provider to map the Wholesale subscriber to a Cisco Webex Wholesale customer and assign the required licenses and entitlements for Webex, Calling and Meetings.\n\n**Note:**\n\n* If this subscriber is an existing Webex Calling entitled user, the `locationId`, `primaryPhoneNumber` and `extension` are optional and if provided are ignored.\n\n**packages Note:**\n\n* `attendant_console` is dependent on: `webex_calling`, `webex_suite`, `cx_essentials`\n\n\n\nEither `packages` or `package` field is required but not both.\n\n
",
"tags": [
"Wholesale Provisioning"
],
"parameters": [
{
"name": "onBehalfOfSubPartnerOrgId",
"in": "query",
"description": "The encoded organization ID for the sub partner.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"customerId": "ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ",
"email": "john.anderson@acme.com",
"packages": [
"webex_calling"
],
"provisioningParameters": {
"firstName": "John",
"lastName": "Andersen",
"primaryPhoneNumber": "+12405551212",
"extension": "51212",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAxMjM0NTY3LTg5YWItY2RlZi0wMTIzLTQ1Njc4OWFiY2RlZg=="
}
},
"schema": {
"type": "object",
"required": [
"customerId",
"email",
"provisioningParameters"
],
"properties": {
"customerId": {
"type": "string",
"example": "ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ",
"description": "ID of the Provisioned Customer for Webex Wholesale."
},
"email": {
"type": "string",
"example": "john.anderson@acme.com",
"description": "The email address of the subscriber (mandatory for the trusted email provisioning flow)."
},
"package": {
"type": "string",
"enum": [
"webex_calling",
"webex_meetings",
"webex_suite",
"webex_voice",
"cx_essentials",
"webex_calling_standard"
],
"description": "The Webex Wholesale package to be assigned to the subscriber. **NOTE:** This parameter will be deprecated soon. Please\n\nuse `packages` instead.\n * `webex_calling` - Calling Basic Package.\n * `webex_meetings` - Meetings Package.\n * `webex_suite` - Suite Package.\n * `webex_voice` - Voice Package.\n * `cx_essentials` - Customer Assist Package.\n * `webex_calling_standard` - Webex Calling Standard Package.\n"
},
"packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WholesalePackagesSubscriber"
},
"description": "The complete list of Webex Wholesale packages assigned to the subscriber. Currently accepts only one package in the list."
},
"provisioningParameters": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"example": "\"John\"",
"description": "The first name of the subscriber."
},
"lastName": {
"type": "string",
"example": "\"Andersen\"",
"description": "The last name of the subscriber."
},
"primaryPhoneNumber": {
"type": "string",
"example": "\"+12405551212\"",
"description": "The primary phone number configured for the subscriber. A primary phone number, extension, or both must be supplied when assigning a calling-enabled package, unless the subscriber is an existing Webex Calling entitled user."
},
"extension": {
"type": "string",
"example": "\"51212\"",
"description": "The extension configured for the subscriber. An extension, primary phone number or both must be supplied when assigning a calling-enabled package, unless the subscriber is an existing Webex Calling entitled user."
},
"locationId": {
"type": "string",
"example": "\"Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAxMjM0NTY3LTg5YWItY2RlZi0wMTIzLTQ1Njc4OWFiY2RlZg==\"",
"description": "A unique identifier for the location. This ID should be retrieved via the [List Locations](/docs/api/v1/locations/list-locations) API."
}
}
}
}
}
}
}
}
}
},
"/wholesale/subscribers/{subscriberId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {
"Location": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscriber"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2",
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"email": "johnandersen@acme.com",
"customerId": "Y2lzY29zcGFyazovL3VzL0NVU1RPTUVSL2Y1YjM2MTg3LWM4ZGQtNDcyNy04YjJmLWY5YzQ0N2YyOTA0Ng",
"externalCustomerId": "c1677a16-557a-4fb4-b48f-24adde57ec99",
"package": "webex_calling",
"status": "provisioned",
"lastStatusChange": "2021-08-06T02:05:41.791232Z",
"created": "2021-08-06T02:03:00.062Z",
"packages": [
"webex_calling"
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get a Wholesale Subscriber",
"operationId": "Get a Wholesale Subscriber",
"description": "Retrieves details of a provisioned Wholesale subscriber on Cisco Webex.",
"tags": [
"Wholesale Provisioning"
],
"parameters": [
{
"name": "subscriberId",
"in": "path",
"description": "A unique identifier for the subscriber in question.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk",
"schema": {
"type": "string"
}
},
{
"name": "onBehalfOfSubPartnerOrgId",
"in": "query",
"description": "The encoded organization ID for the sub partner.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"schema": {
"type": "string"
}
}
]
},
"put": {
"responses": {
"200": {
"description": "OK",
"headers": {
"Location": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscriber"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"email": "johnandersen@acme.com",
"customerId": "Y2lzY29zcGFyazovL3VzL0NVU1RPTUVSL2Y1YjM2MTg3LWM4ZGQtNDcyNy04YjJmLWY5YzQ0N2YyOTA0Ng",
"externalCustomerId": "c1677a16-557a-4fb4-b48f-24adde57ec99",
"package": "webex_calling",
"status": "provisioned",
"lastStatusChange": "2021-08-06T02:05:41.791232Z",
"created": "2021-08-06T02:03:00.062Z",
"packages": [
"webex_calling"
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Update a Wholesale Subscriber",
"operationId": "Update a Wholesale Subscriber",
"description": "Updates certain details of a provisioned Wholesale subscriber.\n\n**Note:**\n\n* The `provisioningParameters` attributes should only be supplied when changing from the webex_meetings package to any calling-enabled package.\n\n* Even in that scenario, if this subscriber is an existing Webex Calling entitled user, these attributes are optional and if provided are ignored.\n\n**packages Note:**\n\n* `attendant_console` is dependent on: `webex_calling`, `webex_suite`, `cx_essentials`\n\n\n\nEither `packages` or `package` field is required but not both.\n\n
",
"tags": [
"Wholesale Provisioning"
],
"parameters": [
{
"name": "subscriberId",
"in": "path",
"description": "A unique identifier for the subscriber in question.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk",
"schema": {
"type": "string"
}
},
{
"name": "onBehalfOfSubPartnerOrgId",
"in": "query",
"description": "The encoded organization ID for the sub partner.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"packages": [
"webex_calling"
],
"provisioningParameters": {
"primaryPhoneNumber": "+1-240-555-1212",
"extension": "5221",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAxMjM0NTY3LTg5YWItY2RlZi0wMTIzLTQ1Njc4OWFiY2RlZg=="
}
},
"schema": {
"type": "object",
"properties": {
"package": {
"$ref": "#/components/schemas/WholesalePackagesSubscriber",
"description": "The Webex Wholesale package to be assigned to the subscriber. **NOTE:** This parameter will be deprecated soon. Please\n\nuse `packages` instead."
},
"packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WholesalePackagesSubscriber"
},
"description": "The complete list of Webex Wholesale packages assigned to the subscriber. Currently accepts only one package in the list."
},
"provisioningParameters": {
"type": "object",
"properties": {
"primaryPhoneNumber": {
"type": "string",
"example": "\"+1-240-555-1212\"",
"description": "The primary phone number configured for the subscriber. A primary phone number, extension, or both must be supplied when changing from the webex_meetings package to any calling-enabled package."
},
"extension": {
"type": "string",
"example": "\"5221\"",
"description": "The extension configured for the subscriber. An extension, primary phone number or both must be supplied when changing from the webex_meetings package to any calling-enabled package."
},
"locationId": {
"type": "string",
"example": "\"Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAxMjM0NTY3LTg5YWItY2RlZi0wMTIzLTQ1Njc4OWFiY2RlZg==\"",
"description": "A unique identifier for the location. This id should be retrieved via the [List Locations](/docs/api/v1/locations/list-locations) API."
}
}
}
}
}
}
}
}
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Remove a Wholesale Subscriber",
"operationId": "Remove a Wholesale Subscriber",
"description": "Removes the mapping between Wholesale Subscriber and a Webex user.",
"tags": [
"Wholesale Provisioning"
],
"parameters": [
{
"name": "subscriberId",
"in": "path",
"description": "A unique identifier for the subscriber in question.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk",
"schema": {
"type": "string"
}
},
{
"name": "onBehalfOfSubPartnerOrgId",
"in": "query",
"description": "The encoded organization ID for the sub partner.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"schema": {
"type": "string"
}
}
]
}
},
"/wholesale/subscribers/validate": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriberProvisioningPrecheckResponse"
},
"example": {
"message": "success",
"info": [
{
"infoCode": 100,
"description": "Provisioning preCheck validation successful."
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Precheck a Wholesale Subscriber Provisioning",
"operationId": "Precheck a Wholesale Subscriber Provisioning",
"description": "Allows the Partner sales team to verify likely success of provisioning a wholesale subscriber.\n**packages Note:**\n\n* `attendant_console` is dependent on: `webex_calling`, `webex_suite`, `cx_essentials`\n\n\n\nThe Prerequisite for using this API is to have `wxc-wholesale` entitlement or `webex-wholesale-partner-testing` setting enabled for the Partner Organization. The Provisioning Precheck APIs supports three variants of Wholesale Subscriber Provisioning Precheck Requests. Please refer to [Using the Provisioning Precheck API](/docs/api/guides/webex-for-wholesale#using-the-precheck-provisioning-api) section in [Webex for Wholesale](/docs/api/guides/webex-for-wholesale) guide for more information.\n\n
\n\n\n\nEither `packages` or `package` field is required but not both.\n\n
",
"tags": [
"Wholesale Provisioning"
],
"parameters": [
{
"name": "onBehalfOfSubPartnerOrgId",
"in": "query",
"description": "The encoded organization ID for the sub partner.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"customerId": "ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ",
"email": "alice.anderson@acme.com"
},
"schema": {
"type": "object",
"required": [
"email"
],
"properties": {
"provisioningId": {
"type": "string",
"example": "ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2",
"description": "Defines how this wholesale subscriber is to be provisioned for Cisco Webex Services.\n\nEach Customer template has its unique provisioning ID. This ID is displayed under the chosen customer template on Cisco Webex Control Hub."
},
"customerId": {
"type": "string",
"example": "ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ",
"description": "ID of the Provisioned Customer for Webex Wholesale."
},
"email": {
"type": "string",
"example": "john.anderson@acme.com",
"description": "The email address of the subscriber."
},
"package": {
"type": "string",
"enum": [
"webex_calling",
"webex_meetings",
"webex_suite",
"webex_voice",
"cx_essentials",
"webex_calling_standard"
],
"description": "The Webex Wholesale package to be assigned to the subscriber. **NOTE:** This parameter will be deprecated soon. Please\n\nuse `packages` instead.\n * `webex_calling` - Calling Basic Package.\n * `webex_meetings` - Meetings Package.\n * `webex_suite` - Suite Package.\n * `webex_voice` - Voice Package.\n * `cx_essentials` - Customer Assist Package.\n * `webex_calling_standard` - Webex Calling Standard Package.\n"
},
"packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WholesalePackagesSubscriber"
},
"description": "The complete list of Webex Wholesale packages assigned to the subscriber. Currently accepts only one package in the list."
},
"provisioningParameters": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"example": "\"John\"",
"description": "The first name of the subscriber."
},
"lastName": {
"type": "string",
"example": "\"Andersen\"",
"description": "The last name of the subscriber."
},
"primaryPhoneNumber": {
"type": "string",
"example": "\"+12405551212\"",
"description": "The primary phone number configured for the subscriber."
},
"extension": {
"type": "string",
"example": "\"51212\"",
"description": "The extension configured for the subscriber. An extension, primary phone number or both must be supplied when creating a subscriber."
},
"locationId": {
"type": "string",
"example": "\"Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAxMjM0NTY3LTg5YWItY2RlZi0wMTIzLTQ1Njc4OWFiY2RlZg==\"",
"description": "A unique identifier for the location. This ID should be retrieved via the Locations API - List Locations."
}
}
},
"customerInfo": {
"type": "object",
"required": [
"primaryEmail"
],
"properties": {
"primaryEmail": {
"type": "string",
"example": "\"john.anderson@acme.com\"",
"description": "The primary email address of the customer."
}
}
}
}
}
}
}
}
}
},
"/subscribers/{subscriberId}/emails/consentMove": {
"post": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Send Consent User Move Email to Pending Wholesale Subscribers",
"operationId": "Send Consent User Move Email to Pending Wholesale Subscribers",
"description": "Allows a Service Provider to send the user consent move email to a subscriber who is currently in `pending_user_migration` state.",
"tags": [
"Wholesale Provisioning"
],
"parameters": [
{
"name": "subscriberId",
"in": "path",
"description": "A unique identifier for the subscriber in question.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk",
"schema": {
"type": "string"
}
},
{
"name": "onBehalfOfSubPartnerOrgId",
"in": "query",
"description": "The encoded organization ID for the sub partner.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"schema": {
"type": "string"
}
}
]
}
}
},
"components": {
"schemas": {
"AcdObject": {
"type": "object",
"required": [
"enabled",
"displayCallqueueAgentSoftkeys"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the ACD object is enabled."
},
"displayCallqueueAgentSoftkeys": {
"$ref": "#/components/schemas/DisplayCallqueueAgentSoftkeysObject",
"description": "Indicates the call queue agent soft key value of an ACD object."
}
}
},
"AcdObjectDevice": {
"type": "object",
"required": [
"enabled",
"displayCallqueueAgentSoftkeys"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the ACD object is enabled."
},
"displayCallqueueAgentSoftkeys": {
"$ref": "#/components/schemas/DisplayCallqueueAgentSoftkeysObject",
"description": "Indicates the call queue agent soft key value of an ACD object."
}
}
},
"ActivationStates": {
"type": "string",
"enum": [
"activating",
"activated",
"deactivated"
],
"description": " * `activating` - Device is activating using an activation code.\n * `activated` - Device has been activated using an activation code.\n * `deactivated` - Device has not been activated using an activation code.\n"
},
"AdminBatchStartJobObjectLocationCustomizations": {
"type": "object",
"properties": {
"locationId": {
"type": "string",
"example": "'Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA'",
"description": "Location within an organization where changes of device setings will be applied to all the devices within it."
},
"locationCustomizationsEnabled": {
"type": "boolean",
"description": "Indicates if all the devices within this location will be customized with new requested customizations(if set to `true`) or will be overridden with the one at organization level (if set to `false` or any other value). This field has no effect when the job is being triggered at organization level."
},
"customizations": {
"$ref": "#/components/schemas/CustomizationObject",
"description": "Indicates the settings for ATA devices, DECT devices and MPP devices."
}
}
},
"AtaDtmfMethodObject": {
"type": "string",
"enum": [
"INBAND",
"AVT",
"AUTO"
],
"description": " * `INBAND` - Sends DTMF by using the audio path.\n * `AVT` - Audio video transport. Sends DTMF as AVT events.\n * `AUTO` - Uses InBand or AVT based on the outcome of codec negotiation.\n"
},
"AtaDtmfModeObject": {
"type": "string",
"enum": [
"STRICT",
"NORMAL"
],
"description": " * `STRICT` - A DTMF digit requires an extra hold time after detection and the DTMF level threshold is raised to -20 dBm.\n * `NORMAL` - Normal threshold mode.\n"
},
"AudioCodecPriorityObject": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"$ref": "#/components/schemas/SelectionType",
"description": "Indicates the selection of an Audio Codec Priority Object."
},
"primary": {
"type": "string",
"example": "G711a",
"description": "Indicates the primary Audio Codec."
},
"secondary": {
"type": "string",
"example": "G711u",
"description": "Indicates the secondary Audio Codec."
},
"tertiary": {
"type": "string",
"example": "G729a",
"description": "Indicates the tertiary Audio Codec."
}
}
},
"AudioCodecPriorityObjectDevice": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"$ref": "#/components/schemas/SelectionType",
"description": "Indicates the selection of an Audio Codec Priority Object."
},
"primary": {
"type": "string",
"example": "G711a",
"description": "Indicates the primary Audio Codec."
},
"secondary": {
"type": "string",
"example": "G711u",
"description": "Indicates the secondary Audio Codec."
},
"tertiary": {
"type": "string",
"example": "G729a",
"description": "Indicates the tertiary Audio Codec."
}
}
},
"AuthenticationMethodObject": {
"type": "string",
"enum": [
"NONE",
"EAP_FAST",
"PEAP_GTC",
"PEAP_MSCHAPV2",
"PSK",
"WEP"
],
"description": " * `NONE` - No authentication.\n * `EAP_FAST` - Extensible Authentication Protocol-Flexible Authentication via Secure Tunneling. Requires username and password authentication.\n * `PEAP_GTC` - Protected Extensible Authentication Protocol - Generic Token Card. Requires username and password authentication.\n * `PEAP_MSCHAPV2` - Protected Extensible Authentication Protocol - Microsoft Challenge Handshake Authentication Protocol version 2. Requires username and password authentication.\n * `PSK` - Pre-Shared Key. Requires shared passphrase for authentication.\n * `WEP` - Wired Equivalent Privacy. Requires encryption key for authentication.\n"
},
"BackgroundImage": {
"type": "string",
"enum": [
"NONE",
"DARK_BLUE",
"CISCO_DARK_BLUE",
"WEBEX_DARK_BLUE",
"CUSTOM_BACKGROUND"
],
"description": " * `NONE` - Indicates that there will be no background image set for the devices.\n * `DARK_BLUE` - Indicates that dark blue background image will be set for the devices.\n * `CISCO_DARK_BLUE` - Indicates that Cisco themed dark blue background image will be set for the devices.\n * `WEBEX_DARK_BLUE` - Indicates that Cisco Webex dark blue background image will be set for the devices.\n * `CUSTOM_BACKGROUND` - Indicates that a custom background image will be set for the devices.\n * `customUrl` - When this option is selected, a field 'Custom Background URL' needs to be added with the image url. URLs provided must link directly to an image file and be in HTTP, HTTPS, or filepath format.\n"
},
"BackgroundImageColor": {
"type": "string",
"enum": [
"CYAN_DARK",
"PURPLE_DARK",
"BLUE_DARK",
"VIOLET_DARK",
"BLUE_LIGHT",
"VIOLET_LIGHT"
],
"description": " * `CYAN_DARK` - Indicates that dark cyan background image will be set for the devices.\n * `PURPLE_DARK` - Indicates the dark purple background image will be set for the devices.\n * `BLUE_DARK` - Indicates the dark blue background image will be set for the devices.\n * `VIOLET_DARK` - Indicates the dark violet background image will be set for the devices.\n * `BLUE_LIGHT` - Indicates the light blue background image will be set for the devices.\n * `VIOLET_LIGHT` - Indicates the light violet background image will be set for the devices.\n"
},
"BacklightTimer68XX": {
"type": "string",
"enum": [
"ALWAYS_ON",
"TEN_SEC",
"TWENTY_SEC",
"THIRTY_SEC",
"OFF"
],
"description": " * `ALWAYS_ON` - Keep the phone's backlight always on.\n * `TEN_SEC` - Set the phone's backlight to be on for ten seconds.\n * `TWENTY_SEC` - Set the phone's backlight to be on for twenty seconds.\n * `THIRTY_SEC` - Set the phone's backlight to be on for thirty seconds.\n * `OFF` - Keep the phone's backlight off.\n"
},
"BacklightTimer68XXDevice": {
"type": "string",
"enum": [
"ALWAYS_ON",
"TEN_SEC",
"TWENTY_SEC",
"THIRTY_SEC",
"OFF"
],
"description": " * `ALWAYS_ON` - Keep the phone's backlight always on.\n * `TEN_SEC` - Set the phone's backlight to be on for ten seconds.\n * `TWENTY_SEC` - Set the phone's backlight to be on for twenty seconds.\n * `THIRTY_SEC` - Set the phone's backlight to be on for thirty seconds.\n * `OFF` - Keep the phone's backlight off.\n"
},
"BacklightTimerObject": {
"type": "string",
"enum": [
"ONE_MIN",
"FIVE_MIN",
"THIRTY_MIN",
"ALWAYS_ON"
],
"description": " * `ONE_MIN` - Set the phone's backlight to be on for one minute.\n * `FIVE_MIN` - Set the phone's backlight to be on for five minutes.\n * `THIRTY_MIN` - Set the phone's backlight to be on for thirty minutes.\n * `ALWAYS_ON` - Keep the phone's backlight always on.\n"
},
"BacklightTimerObjectDevice": {
"type": "string",
"enum": [
"ONE_MIN",
"FIVE_MIN",
"THIRTY_MIN",
"ALWAYS_ON"
],
"description": " * `ONE_MIN` - Set the phone's backlight to be on for one minute.\n * `FIVE_MIN` - Set the phone's backlight to be on for five minutes.\n * `THIRTY_MIN` - Set the phone's backlight to be on for thirty minutes.\n * `ALWAYS_ON` - Keep the phone's backlight always on.\n"
},
"BluetoothObject": {
"type": "object",
"required": [
"enabled",
"mode"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Bluetooth."
},
"mode": {
"type": "string",
"enum": [
"PHONE"
],
"description": "Select a Bluetooth mode."
},
"PHONE": {
"type": "string"
},
"HANDS_FREE": {
"type": "string"
},
"BOTH": {
"type": "string"
}
}
},
"BluetoothObjectDevice": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Bluetooth."
},
"mode": {
"type": "string",
"enum": [
"PHONE",
"HANDS_FREE",
"BOTH"
],
"description": "Select a Bluetooth mode."
}
}
},
"CallForwardExpandedSoftKey": {
"type": "string",
"enum": [
"ONLY_THE_CALL_FORWARD_ALL",
"ALL_CALL_FORWARDS"
],
"description": " * `ONLY_THE_CALL_FORWARD_ALL` - Set the default call forward expanded soft key behavior to single option.\n * `ALL_CALL_FORWARDS` - Set the default call forward expanded soft key behavior to multiple menu option.\n"
},
"CallHistoryMethod": {
"type": "string",
"enum": [
"WEBEX_UNIFIED_CALL_HISTORY",
"LOCAL_CALL_HISTORY"
],
"description": " * `WEBEX_UNIFIED_CALL_HISTORY` - Set call history to use the unified call history from all of the end user's devices.\n * `LOCAL_CALL_HISTORY` - Set call history to use local device information only.\n"
},
"CommSecurityType": {
"type": "string",
"enum": [
"NONE",
"SSL",
"STARTTLS"
],
"description": " * `NONE` - Sets the LDAP server security protocol to None.\n * `SSL` - Sets the LDAP server security protocol to SSL.\n * `STARTTLS` - Sets the LDAP server security protocol to STARTTLS.\n"
},
"Compression": {
"type": "string",
"enum": [
"ON",
"OFF"
],
"description": " * `ON` - Minimize data use during compression.\n * `OFF` - Ignore data use during compression.\n"
},
"CountObject": {
"type": "object",
"required": [
"totalNumbers",
"numbersDeleted",
"numbersMoved",
"numbersFailed"
],
"properties": {
"totalNumbers": {
"type": "number",
"description": "Indicates the total number of phone numbers requested to be moved."
},
"numbersDeleted": {
"type": "number",
"description": "Indicates the total number of phone numbers successfully deleted."
},
"numbersMoved": {
"type": "number",
"description": "Indicates the total number of phone numbers successfully moved."
},
"numbersFailed": {
"type": "number",
"description": "Indicates the total number of phone numbers failed."
}
}
},
"CustomizationDeviceLevelObject": {
"type": "object",
"properties": {
"ata": {
"$ref": "#/components/schemas/ataObject",
"description": "Applicable device settings for an ATA device."
},
"mpp": {
"$ref": "#/components/schemas/mppObject",
"description": "Applicable device settings for an MPP device."
},
"wifi": {
"$ref": "#/components/schemas/wifiObject",
"description": "Applicable device settings for a WiFi device."
}
}
},
"CustomizationDeviceLevelObjectDevice": {
"type": "object",
"properties": {
"ata": {
"$ref": "#/components/schemas/ataObjectDevice",
"description": "Applicable device settings for an ATA device."
},
"mpp": {
"$ref": "#/components/schemas/mppObjectDevice",
"description": "Applicable device settings for an MPP device."
},
"wifi": {
"$ref": "#/components/schemas/wifiObjectDevice",
"description": "Applicable device settings for a WiFi device."
}
}
},
"CustomizationObject": {
"type": "object",
"properties": {
"ata": {
"$ref": "#/components/schemas/ataObject",
"description": "Settings that are applicable to ATA devices."
},
"dect": {
"$ref": "#/components/schemas/dectObject",
"description": "Settings that are applicable to DECT devices."
},
"mpp": {
"$ref": "#/components/schemas/mppObject",
"description": "Settings that are applicable to MPP devices."
},
"wifi": {
"$ref": "#/components/schemas/wifiObject",
"description": "Settings that are applicable to WiFi."
}
}
},
"DectAudioCodecPriorityObject": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"$ref": "#/components/schemas/SelectionType",
"description": "Indicates the selection of an Audio Codec Priority Object."
},
"primary": {
"type": "string",
"example": "G729",
"description": "Indicates the primary Audio Codec."
},
"secondary": {
"type": "string",
"example": "G711u",
"description": "Indicates the secondary Audio Codec."
},
"tertiary": {
"type": "string",
"example": "G711a",
"description": "Indicates the tertiary Audio Codec."
}
}
},
"DectDeviceList": {
"type": "object",
"required": [
"model",
"displayName"
],
"properties": {
"model": {
"type": "string",
"example": "DMS Cisco DBS110",
"description": "Model name of the device."
},
"displayName": {
"type": "string",
"example": "Cisco DECT 210 Base",
"description": "Display name of the device."
},
"numberOfBaseStations": {
"type": "number",
"example": 250,
"description": "Indicates number of base stations."
},
"numberOfLinePorts": {
"type": "number",
"example": 1000,
"description": "Indicates number of port lines,"
},
"numberOfRegistrationsSupported": {
"type": "number",
"example": 30,
"description": "Indicates number of supported registrations."
}
}
},
"DectVlanObject": {
"type": "object",
"required": [
"enabled",
"value"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Denotes whether the VLAN object of DECT is enabled."
},
"value": {
"type": "number",
"description": "Value of the VLAN Object of DECT."
}
}
},
"DefaultLoggingLevelObject": {
"type": "string",
"enum": [
"STANDARD",
"DEBUGGING"
],
"description": " * `STANDARD` - Enables standard logging.\n * `DEBUGGING` - Enables detailed debugging logging.\n"
},
"DeviceActivationStates": {
"type": "string",
"enum": [
"ACTIVATING",
"ACTIVATED",
"DEACTIVATED"
],
"description": " * `ACTIVATING` - Indicates a device is activating.\n * `ACTIVATED` - Indicates a device is activated.\n * `DEACTIVATED` - Indicates a device is deactivated.\n"
},
"DeviceSettingsObject": {
"type": "object",
"required": [
"customizations",
"customEnabled",
"updateInProgress",
"deviceCount",
"lastUpdateTime"
],
"properties": {
"customizations": {
"$ref": "#/components/schemas/CustomizationDeviceLevelObject",
"description": "Indicates the customization object of the device settings."
},
"customEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates if customization is allowed at a location level. If `true`, customized at a location level. If `false`, not customized; uses customer-level configuration."
},
"updateInProgress": {
"type": "boolean",
"example": true,
"description": "Customer devices setting update status. If `true`, an update is in progress (no further changes are allowed). `If false`, no update in progress (changes are allowed)."
},
"deviceCount": {
"type": "number",
"example": 9,
"description": "Number of devices that will be updated."
},
"lastUpdateTime": {
"type": "number",
"example": 1659624763665,
"description": "Indicates the last updated time."
}
}
},
"DeviceSettingsObjectForDeviceLevel": {
"type": "object",
"required": [
"customizations",
"customEnabled",
"updateInProgress",
"deviceCount",
"lastUpdateTime"
],
"properties": {
"customizations": {
"$ref": "#/components/schemas/CustomizationDeviceLevelObjectDevice",
"description": "Indicates the customization object of the device settings."
},
"customEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates if customization is allowed at a device level. If `true`, customized at a device level. If `false`, not customized; uses customer-level configuration."
},
"updateInProgress": {
"type": "boolean",
"example": true,
"description": "Customer devices setting update status. If `true`, an update is in progress (no further changes are allowed). `If false`, no update in progress (changes are allowed)."
},
"deviceCount": {
"type": "number",
"example": 9,
"description": "Number of devices that will be updated."
},
"lastUpdateTime": {
"type": "number",
"example": 1659624763665,
"description": "Indicates the last updated time."
}
}
},
"DirectoryMethod": {
"type": "string",
"enum": [
"XSI_DIRECTORY",
"WEBEX_DIRECTORY"
],
"description": " * `XSI_DIRECTORY` - Set directory services to use standard XSI query method from the device.\n * `WEBEX_DIRECTORY` - Set directory services to use the Webex Enterprise directory.\n"
},
"DisplayCallqueueAgentSoftkeysObject": {
"type": "string",
"enum": [
"FRONT_PAGE",
"LAST_PAGE"
]
},
"DisplayNameSelection": {
"type": "string",
"enum": [
"PERSON_NUMBER",
"PERSON_FIRST_THEN_LAST_NAME",
"PERSON_LAST_THEN_FIRST_NAME"
],
"description": " * `PERSON_NUMBER` - Indicates that devices will display the person's phone number, or if a person doesn't have a phone number, the location number will be displayed.\n * `PERSON_FIRST_THEN_LAST_NAME` - Indicates that devices will display the name in first name then last name format.\n * `PERSON_LAST_THEN_FIRST_NAME` - Indicates that devices will display the name in last name then first name format.\n"
},
"GetMemberResponse": {
"type": "object",
"required": [
"model",
"maxLineCount"
],
"properties": {
"model": {
"type": "string",
"example": "DMS Cisco 192",
"description": "Model type of the device."
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberObject"
},
"description": "List of members that appear on the device."
},
"maxLineCount": {
"type": "number",
"example": 10,
"description": "Maximum number of lines available for the device."
}
}
},
"Hoteling": {
"type": "object",
"required": [
"enabled",
"limitGuestUse"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable/Disable hoteling Host. Enabling the device for hoteling means that a guest(end user) can log into this host(workspace device) and use this device\n\nas if it were their own. This is useful when traveling to a remote office but still needing to place/receive calls with their telephone number and access features normally available to them on their office phone."
},
"limitGuestUse": {
"type": "boolean",
"description": "Enable limiting the time a guest can use the device. The time limit is configured via `guestHoursLimit`."
},
"guestHoursLimit": {
"type": "number",
"description": "Time Limit in hours until hoteling is enabled. Mandatory if `limitGuestUse` is enabled."
}
}
},
"UserHotelingRequestPatch": {
"type": "object",
"required": [
"hoteling"
],
"properties": {
"hoteling": {
"$ref": "#/components/schemas/HotelingRequest",
"description": "Modify person Device Hoteling Setting."
}
}
},
"HotelingRequest": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable/Disable hoteling Host. Enabling the device for hoteling means that a guest(end user) can log into this host(workspace device) and use this device\n\nas if it were their own. This is useful when traveling to a remote office but still needing to place/receive calls with their telephone number and access features normally available to them on their office phone."
},
"limitGuestUse": {
"type": "boolean",
"description": "Enable limiting the time a guest can use the device. The time limit is configured via `guestHoursLimit`."
},
"guestHoursLimit": {
"type": "number",
"description": "Time Limit in hours until hoteling is enabled. Mandatory if `limitGuestUse` is enabled."
}
}
},
"HttpProxyObject": {
"type": "object",
"required": [
"mode",
"autoDiscoveryEnabled",
"host",
"port",
"packUrl",
"authSettingsEnabled",
"username",
"password"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"OFF",
"AUTO",
"MANUAL"
],
"description": "Mode of the HTTP proxy."
},
"autoDiscoveryEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable auto discovery of the URL."
},
"host": {
"type": "string",
"example": "www.example.wxc",
"description": "Specify the host URL if the HTTP mode is set to `MANUAL`."
},
"port": {
"type": "string",
"example": "3128",
"description": "Specify the port if the HTTP mode is set to `MANUAL`."
},
"packUrl": {
"type": "string",
"example": "www.example.wxc",
"description": "Specify PAC URL if auto discovery is disabled."
},
"authSettingsEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable authentication settings."
},
"username": {
"type": "string",
"example": "john",
"description": "Specify a username if authentication settings are enabled."
},
"password": {
"type": "string",
"example": "private",
"description": "Specify a password if authentication settings are enabled."
}
}
},
"HttpProxyObjectDevice": {
"type": "object",
"required": [
"mode",
"autoDiscoveryEnabled"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"OFF",
"AUTO",
"MANUAL"
],
"description": "Mode of the HTTP proxy."
},
"autoDiscoveryEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable auto discovery of the URL."
},
"host": {
"type": "string",
"example": "www.example.wxc",
"description": "Specify the host URL if the HTTP mode is set to `MANUAL`."
},
"port": {
"type": "string",
"example": "3128",
"description": "Specify the port if the HTTP mode is set to `MANUAL`."
},
"packUrl": {
"type": "string",
"example": "www.example.wxc",
"description": "Specify PAC URL if auto discovery is disabled."
},
"authSettingsEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable authentication settings."
},
"username": {
"type": "string",
"example": "john",
"description": "Specify a username if authentication settings are enabled."
},
"password": {
"type": "string",
"example": "private",
"description": "Specify a password if authentication settings are enabled."
}
}
},
"JobListResponse": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StartJobResponse"
},
"description": "Lists all jobs for the customer in order of most recent one to oldest one irrespective of its status."
}
}
},
"LdapObject": {
"type": "object",
"required": [
"enabled",
"serverAddress",
"serverPort",
"commSecurityType",
"bindDn",
"bindPw",
"baseDn",
"primaryEmailAttribute",
"alternateEmailAttribute"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"serverAddress": {
"type": "string",
"example": "localhost",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"serverPort": {
"type": "number",
"example": 8080,
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"commSecurityType": {
"$ref": "#/components/schemas/CommSecurityType",
"description": "Indicates the selection of the protocol for LDAP service on the phone."
},
"bindDn": {
"type": "string",
"example": "bindDn",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"bindPw": {
"type": "string",
"example": "bindPw",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"baseDn": {
"type": "string",
"example": "baseDn",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"primaryEmailAttribute": {
"type": "string",
"example": "primaryEmailAttribute",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"alternateEmailAttribute": {
"type": "string",
"example": "alternateEmailAttribute",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
}
}
},
"LdapObjectDevice": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"serverAddress": {
"type": "string",
"example": "localhost",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"serverPort": {
"type": "number",
"example": 8080,
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"commSecurityType": {
"$ref": "#/components/schemas/CommSecurityType",
"description": "Indicates the selection of the protocol for LDAP service on the phone."
},
"bindDn": {
"type": "string",
"example": "bindDn",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"bindPw": {
"type": "string",
"example": "bindPw",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"baseDn": {
"type": "string",
"example": "baseDn",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"primaryEmailAttribute": {
"type": "string",
"example": "primaryEmailAttribute",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"alternateEmailAttribute": {
"type": "string",
"example": "alternateEmailAttribute",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
}
}
},
"LineKeyLEDPattern": {
"type": "string",
"enum": [
"DEFAULT",
"PRESET_1"
]
},
"LineKeyLabelSelection": {
"type": "string",
"enum": [
"PERSON_EXTENSION",
"PERSON_FIRST_THEN_LAST_NAME",
"PERSON_LAST_THEN_FIRST_NAME"
],
"description": " * `PERSON_EXTENSION` - This will display the person extension, or if a person doesn't have an extension, the person's first name will be displayed.\n * `PERSON_FIRST_THEN_LAST_NAME` - Indicates that devices will display the name in first name then last name format.\n * `PERSON_LAST_THEN_FIRST_NAME` - Indicates that devices will display the name in last name then first name format.\n"
},
"LineType": {
"type": "string",
"enum": [
"PRIMARY",
"SHARED_CALL_APPEARANCE"
],
"description": " * `PRIMARY` - Primary line for the member.\n * `SHARED_CALL_APPEARANCE` - Shared line for the member. A shared line allows users to receive and place calls to and from another user's extension, using their own device.\n"
},
"DeviceLineType": {
"type": "string",
"enum": [
"PRIMARY",
"SHARED_CALL_APPEARANCE",
"MOBILITY",
"HOTDESKING_GUEST"
],
"description": " * `PRIMARY` - Primary line for the member.\n * `SHARED_CALL_APPEARANCE` - Shared line for the member. A shared line allows users to receive and place calls to and from another user's extension, using their own device.\n * `MOBILITY` - Device is a shared line.\n * `HOTDESKING_GUEST` - Device is a hotdesking guest.\n"
},
"ListDectDeviceType": {
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DectDeviceList"
},
"description": "Contains a list of devices."
}
}
},
"ListDeviceSettingsObject": {
"type": "object",
"required": [
"customizations",
"updateInProgress",
"deviceCount",
"lastUpdateTime"
],
"properties": {
"customizations": {
"$ref": "#/components/schemas/CustomizationObject",
"description": "Customization object of the device settings."
},
"updateInProgress": {
"type": "boolean",
"description": "Progress of the device update."
},
"deviceCount": {
"type": "number",
"example": 22,
"description": "Device count."
},
"lastUpdateTime": {
"type": "number",
"example": 1659624763665,
"description": "Last updated time."
}
}
},
"MACAddressResponse": {
"type": "object",
"required": [
"status",
"macStatus"
],
"properties": {
"status": {
"type": "string",
"enum": [
"OK",
"ERRORS"
],
"description": "Status of MAC address."
},
"macStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MacStatusObject"
},
"description": "Contains an array of all the MAC address provided and their statuses."
}
}
},
"MacStatusObject": {
"type": "object",
"required": [
"mac",
"state"
],
"properties": {
"mac": {
"type": "string",
"example": "00005E0053B4",
"description": "MAC address."
},
"state": {
"type": "string",
"enum": [
"AVAILABLE",
"UNAVAILABLE",
"DUPLICATE_IN_LIST",
"INVALID"
],
"description": "State of the MAC address.\n * `AVAILABLE` - The requested MAC address is available.\n * `UNAVAILABLE` - The requested MAC address is unavailable.\n * `DUPLICATE_IN_LIST` - The requested MAC address is duplicated.\n * `INVALID` - The requested MAC address is invalid.\n"
},
"errorCode": {
"type": "number",
"example": 5675,
"description": "MAC address validation error code."
},
"message": {
"type": "string",
"example": "[Error 5675] MAC Address is in use.",
"description": "Provides a status message about the MAC address."
}
}
},
"MemberObject": {
"type": "object",
"required": [
"id",
"firstName",
"lastName",
"primaryOwner",
"port",
"lineType",
"lineWeight",
"hotlineEnabled",
"hotlineDestination",
"allowCallDeclineEnabled",
"memberType"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
"description": "Unique identifier for the member."
},
"firstName": {
"type": "string",
"example": "John",
"description": "First name of a person or workspace."
},
"lastName": {
"type": "string",
"example": "Smith",
"description": "Last name of a person or workspace."
},
"phoneNumber": {
"type": "string",
"example": "2055552221",
"description": "Phone Number of a person or workspace. In some regions phone numbers are not returned in E.164 format. This will be supported in a future update."
},
"extension": {
"type": "string",
"example": "000",
"description": "Extension of a person or workspace."
},
"routingPrefix": {
"type": "string",
"example": "1234",
"description": "Routing prefix of location."
},
"esn": {
"type": "string",
"example": "1234000",
"description": "Routing prefix + extension of a person or workspace."
},
"primaryOwner": {
"type": "boolean",
"example": true,
"description": "This field indicates whether the person or the workspace is the owner of the device, and points to a primary Line/Port of the device."
},
"port": {
"type": "number",
"example": 1,
"description": "Port number assigned to person or workspace."
},
"t38FaxCompressionEnabled": {
"type": "boolean",
"description": "T.38 Fax Compression setting and is available only for ATA Devices. Choose T.38 fax compression if the device requires this option. This will override user level compression options."
},
"lineType": {
"$ref": "#/components/schemas/LineType",
"description": "Line type is used to differentiate Primary and SCA, at which endpoint it is assigned."
},
"lineWeight": {
"type": "number",
"example": 1,
"description": "Number of lines that have been configured for the person on the device."
},
"hostIP": {
"type": "string",
"example": "10.0.0.45",
"description": "Registration Host IP address for the line port."
},
"remoteIP": {
"type": "string",
"example": "192.102.12.84",
"description": "Registration Remote IP address for the line port."
},
"hotlineEnabled": {
"type": "boolean",
"example": true,
"description": "Enable Hotline. Configure this line to automatically call a predefined number whenever taken off-hook. Once enabled, the line can only make calls to the predefined number set in hotlineDestination."
},
"hotlineDestination": {
"type": "string",
"example": "+12055552222",
"description": "The preconfigured number for Hotline. Required only if `hotlineEnabled` is set to true."
},
"allowCallDeclineEnabled": {
"type": "boolean",
"example": true,
"description": "Set how a person's device behaves when a call is declined. When set to true, a call decline request is extended to all the endpoints on the device. When set to false, a call decline request only declines the current endpoint."
},
"lineLabel": {
"type": "string",
"example": "share line label",
"description": "Device line label."
},
"linePort": {
"type": "string",
"example": "evypzco5ds@55552222.int10.bcld.webex.com",
"description": "SIP username used in SIP signaling, for example, in registration."
},
"memberType": {
"$ref": "#/components/schemas/MemberType",
"description": "Indicates if the member is of type `PEOPLE` or `PLACE`."
},
"location": {
"$ref": "#/components/schemas/location",
"description": "Location object having a unique identifier for the location and its name."
}
}
},
"MemberType": {
"type": "string",
"enum": [
"PEOPLE",
"PLACE",
"VIRTUAL_LINE"
],
"description": " * `PEOPLE` - Indicates the associated member is a person.\n * `PLACE` - Indicates the associated member is a workspace.\n * `VIRTUAL_LINE` - Indicates the associated member is a virtual line.\n"
},
"MppAudioCodecPriorityObject": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"type": "string",
"example": "CUSTOM",
"description": "Indicates the selection of the Audio Codec Priority Object for an MPP object."
},
"primary": {
"type": "string",
"example": "OPUS",
"description": "Indicates the primary Audio Codec for an MPP object."
},
"secondary": {
"type": "string",
"example": "G722",
"description": "Indicates the secondary Audio Codec for an MPP object."
},
"tertiary": {
"type": "string",
"example": "G711u",
"description": "Indicates the tertiary Audio Codec for an MPP object."
}
}
},
"MppAudioCodecPriorityObjectDevice": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"$ref": "#/components/schemas/SelectionType",
"description": "Indicates the selection of the Audio Codec Priority Object for an MPP object."
},
"primary": {
"type": "string",
"example": "OPUS",
"description": "Indicates the primary Audio Codec for an MPP object."
},
"secondary": {
"type": "string",
"example": "G722",
"description": "Indicates the secondary Audio Codec for an MPP object."
},
"tertiary": {
"type": "string",
"example": "G711u",
"description": "Indicates the tertiary Audio Codec for an MPP object."
}
}
},
"MppVlanObject": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether the VLAN object of an MPP is enabled."
},
"value": {
"type": "number",
"example": 1,
"description": "Indicates the value of a VLAN object for an MPP object."
},
"pcPort": {
"type": "number",
"example": 1,
"description": "Indicates the PC port value of a VLAN object for an MPP object."
}
}
},
"MppVlanObjectDevice": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether the VLAN object of an MPP is enabled."
},
"value": {
"type": "number",
"example": 1,
"description": "Indicates the value of a VLAN object for an MPP object."
},
"pcPort": {
"type": "number",
"example": 1,
"description": "Indicates the PC port value of a VLAN object for an MPP object."
}
}
},
"NoiseCancellationObject": {
"type": "object",
"required": [
"enabled",
"allowEndUserOverrideEnabled"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the Noise Cancellation."
},
"allowEndUserOverrideEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable to preserve the existing values on the phone and not the value defined for the device setting."
}
}
},
"PhoneLanguage": {
"type": "string",
"enum": [
"PERSON_LANGUAGE",
"ARABIC",
"BULGARIAN",
"CATALAN",
"CHINESE_SIMPLIFIED",
"CHINESE_TRADITIONAL",
"CROATIAN",
"CZECH",
"DANISH",
"DUTCH",
"ENGLISH_UNITED_STATES",
"ENGLISH_UNITED_KINGDOM",
"FINNISH",
"FRENCH_CANADA",
"FRENCH_FRANCE",
"GERMAN",
"GREEK",
"HEBREW",
"HUNGARIAN",
"ITALIAN",
"JAPANESE",
"KOREAN",
"NORWEGIAN",
"POLISH",
"PORTUGUESE_PORTUGAL",
"RUSSIAN",
"SPANISH_COLOMBIA",
"SPANISH_SPAIN",
"SLOVAK",
"SWEDISH",
"SLOVENIAN",
"TURKISH",
"UKRAINE"
],
"description": " * `PERSON_LANGUAGE` - Indicates a person's announcement language.\n"
},
"PoeMode": {
"type": "string",
"enum": [
"NORMAL",
"MAXIMUM"
],
"description": " * `NORMAL` - Use normal power consumption.\n * `MAXIMUM` - Use maximum power consumption.\n"
},
"PskObject": {
"type": "object",
"required": [
"psk1",
"psk4"
],
"properties": {
"psk1": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK1."
},
"psk2": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK2."
},
"psk3": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK3."
},
"psk4": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK4."
},
"psk5": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK5."
},
"psk6": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK6."
},
"psk7": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK7."
},
"psk8": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK8."
},
"psk9": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK9."
},
"psk10": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK10."
},
"psk11": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK11."
},
"psk12": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK12."
},
"psk13": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK13."
},
"psk14": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK14."
},
"psk15": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK15."
},
"psk16": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK16."
}
}
},
"PutDeviceSettingsRequest": {
"type": "object",
"required": [
"customizations",
"customEnabled"
],
"properties": {
"customizations": {
"$ref": "#/components/schemas/CustomizationDeviceLevelObjectDevice",
"description": "Indicates the customization object of the device settings."
},
"customEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates if customization is allowed at a device level. If true, customized at a device level. If false, not customized; uses customer-level configuration."
}
}
},
"PutMemberObject": {
"type": "object",
"required": [
"port",
"id",
"primaryOwner",
"lineType",
"lineWeight",
"hotlineEnabled",
"hotlineDestination",
"allowCallDeclineEnabled"
],
"properties": {
"port": {
"type": "number",
"example": 1,
"description": "Person's assigned port number."
},
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
"description": "Unique identifier for the member."
},
"t38FaxCompressionEnabled": {
"type": "boolean",
"description": "T.38 Fax Compression setting and is available only for ATA Devices. Choose T.38 fax compression if the device requires this option. This will override user level compression options."
},
"primaryOwner": {
"type": "boolean",
"example": true,
"description": "Whether the user is the owner of the device or not, and points to a primary Line/Port of device."
},
"lineType": {
"$ref": "#/components/schemas/LineType",
"description": "Line type is used to differentiate Primary and SCA, at which endpoint it is assigned."
},
"lineWeight": {
"type": "number",
"example": 1,
"description": "Number of lines that have been configured for the person on the device."
},
"hotlineEnabled": {
"type": "boolean",
"example": true,
"description": "Enable Hotline. Configure this line to automatically call a predefined number whenever taken off-hook. Once enabled, the line can only make calls to the predefined number set in hotlineDestination."
},
"hotlineDestination": {
"type": "string",
"example": "+12055552222",
"description": "The preconfigured number for Hotline. Required only if `hotlineEnabled` is set to true."
},
"allowCallDeclineEnabled": {
"type": "boolean",
"example": true,
"description": "Set how a person's device behaves when a call is declined. When set to true, a call decline request is extended to all the endpoints on the device. When set to false, a call decline request only declines the current endpoint."
},
"lineLabel": {
"type": "string",
"example": "share line label",
"description": "Device line label."
}
}
},
"PutMembersRequest": {
"type": "object",
"properties": {
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PutMemberObject"
},
"description": "This specifies the new list of device members, completely replacing the existing device members. If the member's list is omitted then all the users are removed except the primary user."
}
}
},
"ScreenTimeoutObject": {
"type": "object",
"required": [
"enabled",
"value"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the Screen Time object is enabled."
},
"value": {
"type": "number",
"example": 400,
"description": "Indicates the value of screen timeout."
}
}
},
"SearchMemberObject": {
"type": "object",
"required": [
"id",
"firstName",
"lastName",
"lineType",
"allowCallDeclineEnabled",
"memberType"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
"description": "Unique identifier for the member."
},
"firstName": {
"type": "string",
"example": "John",
"description": "First name of a person or workspace."
},
"lastName": {
"type": "string",
"example": "Smith",
"description": "Last name of a person or workspace."
},
"phoneNumber": {
"type": "string",
"example": "+12055552221",
"description": "Phone Number of a person or workspace."
},
"t38FaxCompressionEnabled": {
"type": "boolean",
"description": "T.38 Fax Compression setting and available only for ATA Devices. Choose T.38 fax compression if the device requires this option. this will override user level compression options."
},
"lineType": {
"$ref": "#/components/schemas/LineType",
"description": "Line type is used to differentiate Primary and SCA, at which endpoint it is assigned."
},
"allowCallDeclineEnabled": {
"type": "boolean",
"example": true,
"description": "Set how a person's device behaves when a call is declined. When set to true, a call decline request is extended to all the endpoints on the device. When set to false, a call decline request only declines the current endpoint."
},
"memberType": {
"$ref": "#/components/schemas/MemberType",
"description": "Indicates if member is of type `PEOPLE` or `PLACE`."
},
"location": {
"$ref": "#/components/schemas/location",
"description": "Location object having a unique identifier for the location and its name."
}
}
},
"SearchMemberResponse": {
"type": "object",
"properties": {
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchMemberObject"
},
"description": "List of members available for the device."
}
}
},
"SelectionType": {
"type": "string",
"enum": [
"REGIONAL",
"CUSTOM"
],
"description": " * `REGIONAL` - Indicates the regional selection type for audio codec priority.\n * `CUSTOM` - Indicates the custom selection type for audio codec priority.\n"
},
"SnmpObject": {
"type": "object",
"required": [
"enabled",
"trustedIP",
"getCommunity",
"setCommunity",
"snmpV3Enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Denotes whether the Simple Network Management Protocol of an ATA is enabled."
},
"trustedIP": {
"type": "string",
"example": "10.0.0.45",
"description": "Trusted IPv4 address and subnet mask in this order: 0.0.0.0/0.0.0.0."
},
"getCommunity": {
"type": "string",
"example": "public",
"description": "Read-only community string that allows/denies access to other device's statistics. Default value is `public`."
},
"setCommunity": {
"type": "string",
"example": "private",
"description": "Read-write community string that protects the device against unauthorized changes. Must never be set to `public`."
},
"snmpV3Enabled": {
"type": "boolean",
"description": "Denotes whether the SNMPv3 security is enabled."
}
}
},
"SoftKeyLayoutObject": {
"type": "object",
"required": [
"softKeyMenu",
"psk",
"softKeyMenuDefaults",
"pskDefaults"
],
"properties": {
"softKeyMenu": {
"$ref": "#/components/schemas/SoftKeyMenuObject",
"description": "Customize SoftKey menu settings."
},
"psk": {
"$ref": "#/components/schemas/PskObject",
"description": "Customize PSK."
},
"softKeyMenuDefaults": {
"$ref": "#/components/schemas/SoftKeyMenuObject",
"description": "Default SoftKey menu settings."
},
"pskDefaults": {
"$ref": "#/components/schemas/PskObject",
"description": "Default PSK."
}
}
},
"SoftKeyMenuObject": {
"type": "object",
"required": [
"idleKeyList",
"offHookKeyList",
"dialingInputKeyList",
"progressingKeyList",
"connectedKeyList",
"connectedVideoKeyList",
"startTransferKeyList",
"startConferenceKeyList",
"conferencingKeyList",
"releasingKeyList",
"holdKeyList",
"ringingKeyList",
"sharedActiveKeyList",
"sharedHeldKeyList"
],
"properties": {
"idleKeyList": {
"type": "string",
"example": "guestin|;guestout|;acd_login|;acd_logout|;astate|;redial|;newcall|;cfwd|;recents|;dnd|;unpark|;psk1|;gpickup|;pickup|;dir|4;miss|5;selfview|;messages",
"description": "Specify the idle key list."
},
"offHookKeyList": {
"type": "string",
"example": "endcall|1;redial|2;dir|3;lcr|4;unpark|5;pickup|6;gpickup|7",
"description": "Specify the off hook key list."
},
"dialingInputKeyList": {
"type": "string",
"example": "dial|1;cancel|2;delchar|3;left|5;right|6",
"description": "Specify the dialing input key list."
},
"progressingKeyList": {
"type": "string",
"example": "endcall|2",
"description": "Specify the progressing key list."
},
"connectedKeyList": {
"type": "string",
"example": "hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume",
"description": "Specify the connected key list."
},
"connectedVideoKeyList": {
"type": "string",
"example": "hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume",
"description": "Specify the connected video key list."
},
"startTransferKeyList": {
"type": "string",
"example": "endcall|2;xfer|3",
"description": "Start the transfer key list."
},
"startConferenceKeyList": {
"type": "string",
"example": "endcall|2;conf|3",
"description": "Start the conference key list."
},
"conferencingKeyList": {
"type": "string",
"example": "endcall;join;crdstart;crdstop;crdpause;crdresume",
"description": "Specify the conferencing key list."
},
"releasingKeyList": {
"type": "string",
"example": "endcall|2",
"description": "Specify the releasing key list."
},
"holdKeyList": {
"type": "string",
"example": "resume|1;endcall|2;newcall|3;redial|4;dir|5",
"description": "Specify the hold key list."
},
"ringingKeyList": {
"type": "string",
"example": "answer|1;ignore|2",
"description": "Specify the ringing key list."
},
"sharedActiveKeyList": {
"type": "string",
"example": "newcall|1;psk1|2;dir|3;back|4",
"description": "Specify the shared active key list."
},
"sharedHeldKeyList": {
"type": "string",
"example": "resume|1;dir|4",
"description": "Specify the shared held key list."
}
}
},
"StartJobResponse": {
"type": "object",
"required": [
"name",
"id",
"jobType",
"trackingId",
"sourceUserId",
"sourceCustomerId",
"targetCustomerId",
"instanceId",
"latestExecutionStatus",
"operationType",
"sourceLocationId",
"targetLocationId",
"counts"
],
"properties": {
"name": {
"type": "string",
"description": "Job name."
},
"id": {
"type": "string",
"description": "Unique identifier of the job."
},
"jobType": {
"type": "string",
"description": "Job type."
},
"trackingId": {
"type": "string",
"description": "Unique identifier to track the flow of HTTP requests."
},
"sourceUserId": {
"type": "string",
"description": "Unique identifier to identify which user has run the job."
},
"sourceCustomerId": {
"type": "string",
"description": "Unique identifier to identify the customer who has run the job."
},
"targetCustomerId": {
"type": "string",
"description": "Unique identifier to identify the customer for which the job was run."
},
"instanceId": {
"type": "number",
"description": "Unique identifier to identify the instance of the job."
},
"jobExecutionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobExecutionStatusObject1"
},
"description": "Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job."
},
"latestExecutionStatus": {
"type": "string",
"description": "Indicates the most recent status (STARTING, STARTED, COMPLETED, FAILED) of the job at the time of invocation."
},
"latestExecutionExitCode": {
"type": "string",
"enum": [
"UNKNOWN",
"COMPLETED",
"FAILED",
"STOPPED",
"COMPLETED_WITH_ERRORS"
],
"description": "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n"
},
"operationType": {
"type": "string",
"description": "Indicates operation type that was carried out."
},
"sourceLocationId": {
"type": "string",
"description": "Unique location identifier for which the job was run."
},
"targetLocationId": {
"type": "string",
"description": "Unique location identifier for which the numbers have been moved."
},
"counts": {
"$ref": "#/components/schemas/CountObject",
"description": "Job statistics."
}
}
},
"UsbPortsObject": {
"type": "object",
"required": [
"enabled",
"sideUsbEnabled",
"rearUsbEnabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "New Control to Enable/Disable the side USB port."
},
"sideUsbEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable use of the side USB port on the MPP device. Enabled by default."
},
"rearUsbEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable use of the rear USB port on the MPP device."
}
}
},
"ValidateMACRequest": {
"type": "object",
"required": [
"macs"
],
"properties": {
"macs": {
"type": "array",
"items": {
"type": "string",
"example": "ab125678cdef,00005E0053B4"
},
"description": "MAC addresses to be validated."
}
}
},
"VlanObject": {
"type": "object",
"required": [
"enabled",
"value"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Denotes whether the VLAN object of an ATA is enabled."
},
"value": {
"type": "number",
"example": 1,
"description": "The value of the VLAN Object of an ATA object."
}
}
},
"VlanObjectDevice": {
"type": "object",
"required": [
"enabled",
"value"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Denotes whether the VLAN object of an ATA is enabled."
},
"value": {
"type": "number",
"example": 1,
"description": "The value of the VLAN Object of an ATA object."
}
}
},
"VolumeSettingsObject": {
"type": "object",
"required": [
"ringerVolume",
"speakerVolume",
"handsetVolume",
"headsetVolume",
"eHookEnabled",
"allowEndUserOverrideEnabled"
],
"properties": {
"ringerVolume": {
"type": "number",
"example": 9,
"description": "Specify a ringer volume level through a numeric value between 0 and 15."
},
"speakerVolume": {
"type": "number",
"example": 11,
"description": "Specify a speaker volume level through a numeric value between 0 and 15."
},
"handsetVolume": {
"type": "number",
"example": 10,
"description": "Specify a handset volume level through a numeric value between 0 and 15."
},
"headsetVolume": {
"type": "number",
"example": 10,
"description": "Specify a headset volume level through a numeric value between 0 and 15."
},
"eHookEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the wireless headset hookswitch control."
},
"allowEndUserOverrideEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable to preserve the existing values on the phone and not the values defined for the device settings."
}
}
},
"WebAccessObject": {
"type": "object",
"required": [
"enabled",
"password"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Ability to enable or disable the web browser access for the 840/860."
},
"password": {
"type": "string",
"example": "password",
"description": "Ability to set a Web Server Password."
}
}
},
"WifiAudioCodecPriorityObject": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"$ref": "#/components/schemas/SelectionType",
"description": "Indicates the selection of the Audio Codec Priority Object for an WiFi object."
},
"primary": {
"type": "string",
"example": "OPUS",
"description": "Indicates the primary Audio Codec for an WiFi object."
},
"secondary": {
"type": "string",
"example": "G722",
"description": "Indicates the secondary Audio Codec for an WiFi object."
},
"tertiary": {
"type": "string",
"example": "G711u",
"description": "Indicates the tertiary Audio Codec for an WiFi object."
}
}
},
"WifiAudioCodecPriorityObjectDevice": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"type": "string",
"example": "CUSTOM",
"description": "Indicates the selection of the Audio Codec Priority Object for an WiFi object."
},
"primary": {
"type": "string",
"example": "OPUS",
"description": "Indicates the primary Audio Codec for an WiFi object."
},
"secondary": {
"type": "string",
"example": "G722",
"description": "Indicates the secondary Audio Codec for an WiFi object."
},
"tertiary": {
"type": "string",
"example": "G711u",
"description": "Indicates the tertiary Audio Codec for an WiFi object."
}
}
},
"WifiNetworkObject": {
"type": "object",
"required": [
"enabled",
"authenticationMethod",
"ssidName",
"userId"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether the wifi network is enabled."
},
"authenticationMethod": {
"$ref": "#/components/schemas/AuthenticationMethodObject",
"description": "Authentication method of wifi network."
},
"ssidName": {
"type": "string",
"example": "my_wifi_network",
"description": "SSID name of the wifi network."
},
"userId": {
"type": "string",
"example": "test-user",
"description": "User Id of the wifi network."
}
}
},
"WifiNetworkObjectDevice": {
"type": "object",
"required": [
"enabled",
"authenticationMethod",
"ssidName",
"userId"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether the wifi network is enabled."
},
"authenticationMethod": {
"$ref": "#/components/schemas/AuthenticationMethodObject",
"description": "Authentication method of the WiFi network."
},
"ssidName": {
"type": "string",
"example": "my_wifi_network",
"description": "SSID name of the wifi network."
},
"userId": {
"type": "string",
"example": "test-user",
"description": "User ID for the WiFi network."
}
}
},
"ataObject": {
"type": "object",
"required": [
"audioCodecPriority",
"ataDtmfMode",
"ataDtmfMethod",
"cdpEnabled",
"lldpEnabled",
"qosEnabled",
"vlan",
"webAccessEnabled",
"nightlyResyncEnabled",
"snmp"
],
"properties": {
"audioCodecPriority": {
"$ref": "#/components/schemas/AudioCodecPriorityObject",
"description": "Choose up to three predefined codec priority options available for your region."
},
"ataDtmfMode": {
"$ref": "#/components/schemas/AtaDtmfModeObject",
"description": "DTMF Detection Tx Mode selection for Cisco ATA devices."
},
"ataDtmfMethod": {
"$ref": "#/components/schemas/AtaDtmfMethodObject",
"description": "Method for transmitting DTMF signals to the far end."
},
"cdpEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Cisco Discovery Protocol for local devices."
},
"lldpEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Link Layer Discovery Protocol for local devices."
},
"qosEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable quality of service tagging of packets from the local device to the Webex Calling platform."
},
"vlan": {
"$ref": "#/components/schemas/VlanObject",
"description": "Specify a numeric Virtual LAN ID for devices."
},
"webAccessEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable user level web access to the local device."
},
"nightlyResyncEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the automatic nightly configuration resync of the MPP device."
},
"snmp": {
"$ref": "#/components/schemas/SnmpObject",
"description": "Specify values needed to enable use of the SNMP service from the phone."
}
}
},
"ataObjectDevice": {
"type": "object",
"required": [
"audioCodecPriority",
"ataDtmfMode",
"ataDtmfMethod",
"cdpEnabled",
"lldpEnabled",
"qosEnabled",
"vlan",
"webAccessEnabled",
"nightlyResyncEnabled",
"snmp"
],
"properties": {
"audioCodecPriority": {
"$ref": "#/components/schemas/AudioCodecPriorityObjectDevice",
"description": "Choose up to three predefined codec priority options available for your region."
},
"ataDtmfMode": {
"$ref": "#/components/schemas/AtaDtmfModeObject",
"description": "DTMF Detection Tx Mode selection for Cisco ATA devices."
},
"ataDtmfMethod": {
"$ref": "#/components/schemas/AtaDtmfMethodObject",
"description": "Method for transmitting DTMF signals to the far end."
},
"cdpEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Cisco Discovery Protocol for local devices."
},
"lldpEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Link Layer Discovery Protocol for local devices."
},
"qosEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable quality of service tagging of packets from the local device to the Webex Calling platform."
},
"vlan": {
"$ref": "#/components/schemas/VlanObjectDevice",
"description": "Specify a numeric Virtual LAN ID for devices."
},
"webAccessEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable user level web access to the local device."
},
"nightlyResyncEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the automatic nightly configuration resync of the MPP device."
},
"snmp": {
"$ref": "#/components/schemas/SnmpObject",
"description": "Specify values needed to enable use of the SNMP service from the phone."
}
}
},
"dectObject": {
"type": "object",
"required": [
"audioCodecPriority",
"cdpEnabled",
"dect6825HandsetEmergencyNumber",
"lldpEnabled",
"multicast",
"qosEnabled",
"vlan",
"webAccessEnabled",
"nightlyResyncEnabled"
],
"properties": {
"audioCodecPriority": {
"$ref": "#/components/schemas/DectAudioCodecPriorityObject",
"description": "Choose up to three predefined codec priority options available for your region."
},
"cdpEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Cisco Discovery Protocol for local devices."
},
"dect6825HandsetEmergencyNumber": {
"type": "string",
"description": "Specify the destination number to be dialled from the DECT Handset top button when pressed."
},
"lldpEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Link Layer Discovery Protocol for local devices."
},
"multicast": {
"type": "string",
"description": "Specify up to 3 multicast group URLs each with a unique listening port."
},
"qosEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable quality of service tagging of packets from the local device to the Webex Calling platform."
},
"vlan": {
"$ref": "#/components/schemas/DectVlanObject",
"description": "Specify a numeric Virtual LAN ID for devices."
},
"webAccessEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable user level web access to the local device."
},
"nightlyResyncEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable phone's default behavior regarding the nightly maintenance synchronization with the Webex Calling platform."
}
}
},
"deviceList": {
"type": "object",
"required": [
"devices",
"maxDeviceCount",
"maxOwnedDeviceCount"
],
"properties": {
"devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/devices"
},
"description": "Array of devices available to person."
},
"maxDeviceCount": {
"type": "number",
"description": "Maximum number of devices a person can be assigned to."
},
"maxOwnedDeviceCount": {
"type": "number",
"description": "Maximum number of devices a person can own."
}
}
},
"deviceOwner": {
"type": "object",
"required": [
"id",
"type",
"firstName",
"lastName"
],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of a person or a workspace."
},
"type": {
"$ref": "#/components/schemas/MemberType",
"description": "Enumeration that indicates if the member is of type `PEOPLE` or `PLACE`."
},
"firstName": {
"type": "string",
"description": "First name of device owner."
},
"lastName": {
"type": "string",
"description": "Last name of device owner."
}
}
},
"devices": {
"type": "object",
"required": [
"id",
"model",
"primaryOwner",
"type",
"hoteling",
"owner",
"activationState"
],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for a device."
},
"description": {
"type": "array",
"items": {
"type": "string"
},
"description": "Comma separated array of tags used to describe device."
},
"model": {
"type": "string",
"description": "Identifier for device model."
},
"modelType": {
"$ref": "#/components/schemas/DeviceType",
"description": "Identifier for device model type."
},
"mac": {
"type": "string",
"description": "MAC address of device."
},
"ipAddress": {
"type": "string",
"description": "IP address of device."
},
"primaryOwner": {
"type": "boolean",
"description": "Indicates whether the person or the workspace is the owner of the device, and points to a primary Line/Port of the device."
},
"type": {
"$ref": "#/components/schemas/DeviceLineType",
"description": "Indicates if the line is acting as a primary line or a shared line for this device."
},
"hoteling": {
"$ref": "#/components/schemas/HotelingRequest",
"description": "Hoteling login settings, which are available when the device is the owner's primary device and device type is PRIMARY. Hoteling login settings are set at the owner level."
},
"owner": {
"$ref": "#/components/schemas/deviceOwner",
"description": "Owner of device."
},
"activationState": {
"$ref": "#/components/schemas/ActivationStates",
"description": "Activation state of device."
}
}
},
"DeviceType": {
"type": "string",
"enum": [
"MPP",
"ATA",
"GENERIC_SIP",
"ESIM",
"ROOM_OS",
"MOBILE",
"DESK_PHONE"
],
"description": " * `MPP` - Cisco Multiplatform Phone\n * `ATA` - Analog Telephone Adapters\n * `GENERIC_SIP` - GENERIC Session Initiation Protocol\n * `ESIM` - Esim Supported Webex Go\n * `ROOM_OS` - Cisco Webex Room OS and the Room Series device\n * `MOBILE` - Mobile\n * `DESK_PHONE` - Desk Phone\n"
},
"jobIdResponseObject": {
"type": "object",
"required": [
"name",
"id",
"jobType",
"trackingId",
"sourceUserId",
"sourceCustomerId",
"targetCustomerId",
"instanceId",
"latestExecutionStatus",
"operationType",
"sourceLocationId",
"targetLocationId",
"sourceLocationName",
"targetLocationName",
"counts"
],
"properties": {
"name": {
"type": "string",
"description": "Job name."
},
"id": {
"type": "string",
"description": "Unique identifier of the job."
},
"jobType": {
"type": "string",
"description": "Job type."
},
"trackingId": {
"type": "string",
"description": "Unique identifier to track the flow of HTTP requests."
},
"sourceUserId": {
"type": "string",
"description": "Unique identifier to identify which user has run the job."
},
"sourceCustomerId": {
"type": "string",
"description": "Unique identifier to identify the customer who has run the job."
},
"targetCustomerId": {
"type": "string",
"description": "Unique identifier to identify the customer for which the job was run."
},
"instanceId": {
"type": "number",
"description": "Unique identifier to identify the instance of the job."
},
"jobExecutionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobExecutionStatusObject"
},
"description": "Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job."
},
"latestExecutionStatus": {
"type": "string",
"description": "Indicates the most recent status (STARTING, STARTED, COMPLETED, FAILED) of the job at the time of invocation."
},
"latestExecutionExitCode": {
"type": "string",
"enum": [
"UNKNOWN",
"COMPLETED",
"FAILED",
"STOPPED",
"COMPLETED_WITH_ERRORS"
],
"description": "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n"
},
"operationType": {
"type": "string",
"description": "Indicates the operation type that was carried out."
},
"sourceLocationId": {
"type": "string",
"description": "Unique location identifier for which the job was run."
},
"targetLocationId": {
"type": "string",
"description": "Unique location identifier for which the numbers have been moved."
},
"sourceLocationName": {
"type": "string",
"description": "The location name for which the job was run."
},
"targetLocationName": {
"type": "string",
"description": "The location name for which the numbers have been moved."
},
"counts": {
"$ref": "#/components/schemas/CountObject",
"description": "Job statistics."
}
}
},
"location": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw",
"description": "Location identifier associated with the members."
},
"name": {
"type": "string",
"example": "MainOffice",
"description": "Location name associated with the member."
}
}
},
"mppObject": {
"type": "object",
"required": [
"pnacEnabled",
"audioCodecPriority",
"backlightTimer",
"background",
"cdpEnabled",
"defaultLoggingLevel",
"dndServicesEnabled",
"acd",
"shortInterdigitTimer",
"longInterdigitTimer",
"lineKeyLabelFormat",
"lineKeyLEDPattern",
"lldpEnabled",
"mppUserWebAccessEnabled",
"multicast",
"enhancedMulticast",
"offHookTimer",
"phoneLanguage",
"poeMode",
"qosEnabled",
"screenTimeout",
"usbPortsEnabled",
"vlan",
"wifiNetwork",
"callHistory",
"contacts",
"webexMeetingsEnabled",
"volumeSettings",
"cfExpandedSoftKey",
"httpProxy",
"bluetooth",
"passThroughPortEnabled",
"userPasswordOverrideEnabled",
"activeCallFocusEnabled",
"peerFirmwareEnabled",
"noiseCancellation",
"voiceFeedbackAccessibilityEnabled",
"dialAssistEnabled",
"callsPerLine",
"nightlyResyncEnabled",
"missedCallNotificationEnabled",
"softKeyLayout",
"backgroundImage8875",
"backlightTimer68XX78XX",
"allowMonitorLinesEnabled"
],
"properties": {
"pnacEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the PNAC of MPP object is enabled or not."
},
"audioCodecPriority": {
"$ref": "#/components/schemas/MppAudioCodecPriorityObject",
"description": "Choose up to three predefined codec priority options available for your region."
},
"backlightTimer": {
"$ref": "#/components/schemas/BacklightTimerObject",
"description": "Choose the length of time (in minutes) for the phone's backlight to remain on."
},
"background": {
"type": "object",
"properties": {
"image": {
"$ref": "#/components/schemas/BackgroundImage"
},
"customUrl": {
"type": "string"
}
}
},
"displayNameFormat": {
"$ref": "#/components/schemas/DisplayNameSelection",
"description": "The display name that appears on the phone screen."
},
"cdpEnabled": {
"type": "boolean",
"description": "Allows you to enable/disable CDP for local devices."
},
"defaultLoggingLevel": {
"$ref": "#/components/schemas/DefaultLoggingLevelObject",
"description": "Choose the desired logging level for an MPP devices."
},
"dndServicesEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Do-Not-Disturb capabilities for Multi-Platform Phones."
},
"acd": {
"$ref": "#/components/schemas/AcdObject",
"description": "Holds the Acd object value."
},
"shortInterdigitTimer": {
"type": "number",
"example": 14,
"description": "Indicates the short inter digit timer value."
},
"longInterdigitTimer": {
"type": "number",
"example": 16,
"description": "Indicates the long inter digit timer value.."
},
"lineKeyLabelFormat": {
"$ref": "#/components/schemas/LineKeyLabelSelection",
"description": "Line key labels define the format of what's shown next to line keys."
},
"lineKeyLEDPattern": {
"$ref": "#/components/schemas/LineKeyLEDPattern",
"description": "LED patterns define lighting schemes for the line keys on the MPP devices. Note that this parameter is not supported on the MPP 8875"
},
"lldpEnabled": {
"type": "boolean",
"description": "Enable/disable Link Layer Discovery Protocol for local devices."
},
"mppUserWebAccessEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable user-level access to the web interface of Multi-Platform Phones."
},
"multicast": {
"type": "array",
"items": {
"type": "string",
"example": "[\"192.86.108.226:22\"]"
},
"description": "Select up to 10 Multicast Group URLs (each with a unique Listening Port)."
},
"enhancedMulticast": {
"$ref": "#/components/schemas/EnhancedMulticastObject",
"description": "Specify the enhanced multicast settings for the MPP device."
},
"offHookTimer": {
"type": "number",
"example": 30,
"description": "Specify the amount of time (in seconds) that a phone can remain off-hook."
},
"phoneLanguage": {
"$ref": "#/components/schemas/PhoneLanguage",
"description": "Select the language for your MPP phone. Setting this overrides the default language setting in place for your provisioned location."
},
"poeMode": {
"$ref": "#/components/schemas/PoeMode",
"description": "Enable/disable the Power-Over-Ethernet mode for Multi-Platform Phones."
},
"qosEnabled": {
"type": "boolean",
"example": true,
"description": "Allows you to enable/disable tagging of packets from the local device to the Webex Calling platform."
},
"screenTimeout": {
"$ref": "#/components/schemas/ScreenTimeoutObject",
"description": "Specify the amount of inactive time needed (in seconds) before the phone's screen saver activates."
},
"usbPortsEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the use of the USB ports on Multi-Platform phones."
},
"vlan": {
"$ref": "#/components/schemas/MppVlanObject",
"description": "Specify a numeric Virtual LAN ID for devices."
},
"wifiNetwork": {
"$ref": "#/components/schemas/WifiNetworkObject",
"description": "Specify the Wi-Fi SSID and password for wireless-enabled MPP phones."
},
"callHistory": {
"$ref": "#/components/schemas/CallHistoryMethod",
"description": "Specify the call history information to use. Only applies to user devices."
},
"contacts": {
"$ref": "#/components/schemas/DirectoryMethod",
"description": "Specify the directory services to use."
},
"webexMeetingsEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the availability of the webex meetings functionality from the phone."
},
"volumeSettings": {
"$ref": "#/components/schemas/VolumeSettingsObject",
"description": "Specify all volume level values on the phone."
},
"cfExpandedSoftKey": {
"$ref": "#/components/schemas/CallForwardExpandedSoftKey",
"description": "Specify the call forward expanded soft key behavior."
},
"httpProxy": {
"$ref": "#/components/schemas/HttpProxyObject",
"description": "Specify HTTP Proxy values."
},
"bluetooth": {
"$ref": "#/components/schemas/BluetoothObject",
"description": "Enable/disable the visibility of the bluetooth menu on the MPP device."
},
"passThroughPortEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the use of the PC passthrough ethernet port on supported phone models."
},
"userPasswordOverrideEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the ability for an end user to set a local password on the phone to restrict local access to the device."
},
"activeCallFocusEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the default screen behavior when inbound calls are received."
},
"peerFirmwareEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable peer firmware sharing."
},
"noiseCancellation": {
"$ref": "#/components/schemas/NoiseCancellationObject",
"description": "Enable/disable local noise cancellation on active calls from the device."
},
"voiceFeedbackAccessibilityEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable visibility of the Accessibility Voice Feedback menu on the MPP device."
},
"dialAssistEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable availability of dial assist feature on the phone."
},
"callsPerLine": {
"type": "number",
"example": 9,
"description": "Specify the number of calls per unique line appearance on the phone."
},
"nightlyResyncEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable automatic nightly configuration resync of the MPP device."
},
"missedCallNotificationEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the visual indication of missed calls."
},
"softKeyLayout": {
"$ref": "#/components/schemas/SoftKeyLayoutObject",
"description": "Specify the softkey layout per phone menu state."
},
"backgroundImage8875": {
"$ref": "#/components/schemas/BackgroundImageColor",
"description": "Specify the image option for the MPP 8875 phone background."
},
"backlightTimer68XX78XX": {
"$ref": "#/components/schemas/BacklightTimer68XX",
"description": "Specify the use of the backlight feature on 6800 nad 7800 series devices."
},
"allowMonitorLinesEnabled": {
"type": "boolean",
"description": "Enable/disable monitoring for MPP non-primary device."
},
"iceEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable SIP media streams to go directly between phones on the same local network."
}
}
},
"mppObjectDevice": {
"type": "object",
"required": [
"pnacEnabled",
"audioCodecPriority",
"backlightTimer",
"background",
"cdpEnabled",
"defaultLoggingLevel",
"dndServicesEnabled",
"acd",
"shortInterdigitTimer",
"longInterdigitTimer",
"lineKeyLabelFormat",
"lineKeyLEDPattern",
"lldpEnabled",
"mppUserWebAccessEnabled",
"multicast",
"enhancedMulticast",
"offHookTimer",
"phoneLanguage",
"poeMode",
"qosEnabled",
"screenTimeout",
"usbPortsEnabled",
"usbPorts",
"vlan",
"wifiNetwork",
"callHistory",
"contacts",
"webexMeetingsEnabled",
"volumeSettings",
"cfExpandedSoftKey",
"httpProxy",
"bluetooth",
"passThroughPortEnabled",
"userPasswordOverrideEnabled",
"activeCallFocusEnabled",
"peerFirmwareEnabled",
"noiseCancellation",
"voiceFeedbackAccessibilityEnabled",
"dialAssistEnabled",
"callsPerLine",
"nightlyResyncEnabled",
"missedCallNotificationEnabled",
"softKeyLayout",
"backgroundImage8875",
"backlightTimer68XX78XX",
"allowMonitorLinesEnabled"
],
"properties": {
"pnacEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the PNAC of MPP object is enabled or not."
},
"audioCodecPriority": {
"$ref": "#/components/schemas/MppAudioCodecPriorityObjectDevice",
"description": "Choose up to three predefined codec priority options available for your region."
},
"backlightTimer": {
"$ref": "#/components/schemas/BacklightTimerObjectDevice",
"description": "Choose the length of time (in minutes) for the phone's backlight to remain on."
},
"background": {
"type": "object",
"properties": {
"image": {
"$ref": "#/components/schemas/BackgroundImage"
},
"customUrl": {
"type": "string"
}
}
},
"displayNameFormat": {
"$ref": "#/components/schemas/DisplayNameSelection",
"description": "The display name that appears on the phone screen."
},
"cdpEnabled": {
"type": "boolean",
"description": "Allows you to enable/disable CDP for local devices."
},
"defaultLoggingLevel": {
"$ref": "#/components/schemas/DefaultLoggingLevelObject",
"description": "Choose the desired logging level for an MPP devices."
},
"dndServicesEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Do-Not-Disturb capabilities for Multi-Platform Phones."
},
"acd": {
"$ref": "#/components/schemas/AcdObjectDevice",
"description": "Holds the Acd object value."
},
"shortInterdigitTimer": {
"type": "number",
"example": 14,
"description": "Indicates the short inter digit timer value."
},
"longInterdigitTimer": {
"type": "number",
"example": 16,
"description": "Indicates the long inter digit timer value.."
},
"lineKeyLabelFormat": {
"$ref": "#/components/schemas/LineKeyLabelSelection",
"description": "Line key labels define the format of what's shown next to line keys."
},
"lineKeyLEDPattern": {
"$ref": "#/components/schemas/LineKeyLEDPattern",
"description": "LED patterns define lighting schemes for the line keys on the MPP devices. Note that this parameter is not supported on the MPP 8875"
},
"lldpEnabled": {
"type": "boolean",
"description": "Enable/disable Link Layer Discovery Protocol for local devices."
},
"mppUserWebAccessEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable user-level access to the web interface of Multi-Platform Phones."
},
"multicast": {
"type": "array",
"items": {
"type": "string",
"example": "[\"192.86.108.226:22\"]"
},
"description": "Select up to 10 Multicast Group URLs (each with a unique Listening Port)."
},
"enhancedMulticast": {
"$ref": "#/components/schemas/EnhancedMulticastObject",
"description": "Specify the enhanced multicast settings for the MPP device."
},
"offHookTimer": {
"type": "number",
"example": 30,
"description": "Specify the amount of time (in seconds) that a phone can remain off-hook."
},
"phoneLanguage": {
"$ref": "#/components/schemas/PhoneLanguage",
"description": "Select the language for your MPP phone. Setting this overrides the default language setting in place for your provisioned location."
},
"poeMode": {
"$ref": "#/components/schemas/PoeMode",
"description": "Enable/disable the Power-Over-Ethernet mode for Multi-Platform Phones."
},
"qosEnabled": {
"type": "boolean",
"example": true,
"description": "Allows you to enable/disable tagging of packets from the local device to the Webex Calling platform."
},
"screenTimeout": {
"$ref": "#/components/schemas/ScreenTimeoutObject",
"description": "Specify the amount of inactive time needed (in seconds) before the phone's screen saver activates."
},
"usbPortsEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the use of the USB ports on Multi-Platform phones."
},
"usbPorts": {
"$ref": "#/components/schemas/UsbPortsObject",
"description": "By default the Side USB port is enabled to support KEMs and other peripheral devices. Use the option to disable use of this port."
},
"vlan": {
"$ref": "#/components/schemas/MppVlanObjectDevice",
"description": "Specify a numeric Virtual LAN ID for devices."
},
"wifiNetwork": {
"$ref": "#/components/schemas/WifiNetworkObjectDevice",
"description": "Specify the Wi-Fi SSID and password for wireless-enabled MPP phones."
},
"callHistory": {
"$ref": "#/components/schemas/CallHistoryMethod",
"description": "Specify the call history information to use. Only applies to user devices."
},
"contacts": {
"$ref": "#/components/schemas/DirectoryMethod",
"description": "Specify the directory services to use."
},
"webexMeetingsEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the availability of the webex meetings functionality from the phone."
},
"volumeSettings": {
"$ref": "#/components/schemas/VolumeSettingsObject",
"description": "Specify all volume level values on the phone."
},
"cfExpandedSoftKey": {
"$ref": "#/components/schemas/CallForwardExpandedSoftKey",
"description": "Specify the call forward expanded soft key behavior."
},
"httpProxy": {
"$ref": "#/components/schemas/HttpProxyObjectDevice",
"description": "Specify HTTP Proxy values."
},
"bluetooth": {
"$ref": "#/components/schemas/BluetoothObjectDevice",
"description": "Enable/disable the visibility of the bluetooth menu on the MPP device."
},
"passThroughPortEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the use of the PC passthrough ethernet port on supported phone models."
},
"userPasswordOverrideEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the ability for an end user to set a local password on the phone to restrict local access to the device."
},
"activeCallFocusEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the default screen behavior when inbound calls are received."
},
"peerFirmwareEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable peer firmware sharing."
},
"noiseCancellation": {
"$ref": "#/components/schemas/NoiseCancellationObject",
"description": "Enable/disable local noise cancellation on active calls from the device."
},
"voiceFeedbackAccessibilityEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable visibility of the Accessibility Voice Feedback menu on the MPP device."
},
"dialAssistEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable availability of dial assist feature on the phone."
},
"callsPerLine": {
"type": "number",
"example": 9,
"description": "Specify the number of calls per unique line appearance on the phone."
},
"nightlyResyncEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable automatic nightly configuration resync of the MPP device."
},
"missedCallNotificationEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the visual indication of missed calls."
},
"softKeyLayout": {
"$ref": "#/components/schemas/SoftKeyLayoutObject",
"description": "Specify the softkey layout per phone menu state."
},
"backgroundImage8875": {
"$ref": "#/components/schemas/BackgroundImageColor",
"description": "Specify the image option for the MPP 8875 phone background."
},
"backlightTimer68XX78XX": {
"$ref": "#/components/schemas/BacklightTimer68XXDevice",
"description": "Specify the use of the backlight feature on 6800 nad 7800 series devices."
},
"allowMonitorLinesEnabled": {
"type": "boolean",
"description": "Enable/disable monitoring for MPP non-primary device."
},
"iceEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable SIP media streams to go directly between phones on the same local network."
}
}
},
"placeDeviceList": {
"type": "object",
"required": [
"devices",
"maxDeviceCount",
"maxOwnedDeviceCount"
],
"properties": {
"devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/placeDevices"
},
"description": "Array of devices associated with a workspace."
},
"maxDeviceCount": {
"type": "number",
"description": "Maximum number of devices a workspace can be assigned to."
},
"maxOwnedDeviceCount": {
"type": "number",
"description": "Maximum number of devices a workspace can own."
}
}
},
"placeDevices": {
"type": "object",
"required": [
"id",
"model",
"primaryOwner",
"type",
"hoteling",
"owner",
"activationState"
],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for a device."
},
"description": {
"type": "array",
"items": {
"type": "string"
},
"description": "Comma separated array of tags used to describe device."
},
"model": {
"type": "string",
"description": "Identifier for device model."
},
"mac": {
"type": "string",
"description": "MAC address of device."
},
"ipAddress": {
"type": "string",
"description": "IP address of device."
},
"primaryOwner": {
"type": "boolean",
"description": "Indicates whether the person or the workspace is the owner of the device and points to a primary Line/Port of the device."
},
"type": {
"$ref": "#/components/schemas/LineType",
"description": "Indicates if the line is acting as a primary line or a shared line for this device."
},
"hoteling": {
"$ref": "#/components/schemas/Hoteling",
"description": "Indicates Hoteling details of a device."
},
"owner": {
"$ref": "#/components/schemas/deviceOwner",
"description": "Owner of the device."
},
"activationState": {
"$ref": "#/components/schemas/DeviceActivationStates",
"description": "Activation state of a device."
}
}
},
"wifiObject": {
"type": "object",
"required": [
"audioCodecPriority",
"ldap",
"webAccess",
"phoneSecurityPwd"
],
"properties": {
"audioCodecPriority": {
"$ref": "#/components/schemas/WifiAudioCodecPriorityObject",
"description": "Choose up to three predefined codec priority options available for your region."
},
"ldap": {
"$ref": "#/components/schemas/LdapObject",
"description": "Set the values needed to enable use of the LDAP service on the phone."
},
"webAccess": {
"$ref": "#/components/schemas/WebAccessObject",
"description": "Set the availability of the local end user web access for an 840/860 WiFi phone."
},
"phoneSecurityPwd": {
"type": "string",
"example": "phoneSecurityPwd",
"description": "Set the local security password on an 840/860 WiFi phone."
}
}
},
"wifiObjectDevice": {
"type": "object",
"required": [
"audioCodecPriority",
"ldap",
"webAccess",
"phoneSecurityPwd"
],
"properties": {
"audioCodecPriority": {
"$ref": "#/components/schemas/WifiAudioCodecPriorityObjectDevice",
"description": "Choose up to three predefined codec priority options available for your region."
},
"ldap": {
"$ref": "#/components/schemas/LdapObjectDevice",
"description": "Set the values needed to enable use of the LDAP service on the phone."
},
"webAccess": {
"$ref": "#/components/schemas/WebAccessObject",
"description": "Set the availability of the local end user web access for an 840/860 WiFi phone."
},
"phoneSecurityPwd": {
"type": "string",
"example": "phoneSecurityPwd",
"description": "Set the local security password on an 840/860 WiFi phone."
}
}
},
"GetLineKeyTemplateResponse": {
"type": "object",
"required": [
"id",
"templateName",
"deviceModel",
"modelDisplayName",
"userReorderEnabled",
"lineKeys"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS81NzVhMWY3Zi03MjRkLTRmZGUtODk4NC1mNjNhNDljMzYxZmQ",
"description": "Unique identifier for the Line Key Template."
},
"templateName": {
"type": "string",
"example": "Basic Template",
"description": "Name of the Line Key Template."
},
"deviceModel": {
"type": "string",
"example": "'DMS Cisco 6821'",
"description": "The Device Model for which the Line Key Template is applicable."
},
"modelDisplayName": {
"type": "string",
"example": "Cisco 6821",
"description": "The friendly display name used to represent the device model in Control Hub."
},
"userReorderEnabled": {
"type": "boolean",
"description": "Indicates whether user can reorder the line keys."
},
"lineKeys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProgrammableLineKeys"
},
"description": "Contains a mapping of Line Keys and their corresponding actions."
}
}
},
"LineKeyType": {
"type": "string",
"enum": [
"PRIMARY_LINE",
"SHARED_LINE",
"MONITOR",
"CALL_PARK_EXTENSION",
"SPEED_DIAL",
"OPEN",
"CLOSED",
"MODE_MANAGEMENT"
],
"description": " * `PRIMARY_LINE` - PRIMARY_LINE is the user's primary extension. This is the default assignment for Line Key Index 1 and cannot be modified.\n * `SHARED_LINE` - Shows the appearance of other users on the owner's phone.\n * `MONITOR` - Enables User and Call Park monitoring.\n * `CALL_PARK_EXTENSION` - Enables the configure layout feature in Control Hub to set call park extension implicitly.\n * `SPEED_DIAL` - Allows users to reach a telephone number, extension or a SIP URI.\n * `OPEN` - An open key will automatically take the configuration of a monitor button starting with the first open key. These buttons are also usable by the user to configure speed dial numbers on these keys.\n * `CLOSED` - Button not usable but reserved for future features.\n * `MODE_MANAGEMENT` - Allows users to manage call forwarding for features via schedule-based routing.\n"
},
"ApplyLineKeyTemplateJobList": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplyLineKeyTemplateJobDetails"
},
"description": "List of Apply Line Key Template jobs."
}
}
},
"ApplyLineKeyTemplateJobDetails": {
"type": "object",
"required": [
"name",
"id",
"trackingId",
"sourceUserId",
"sourceCustomerId",
"targetCustomerId",
"instanceId",
"latestExecutionStatus",
"percentageComplete",
"updatedCount",
"advisoryCount"
],
"properties": {
"name": {
"type": "string",
"description": "Job name."
},
"id": {
"type": "string",
"description": "Unique identifier of the job."
},
"trackingId": {
"type": "string",
"description": "Unique identifier to track the flow of HTTP requests."
},
"sourceUserId": {
"type": "string",
"description": "Unique identifier to identify which user has run the job."
},
"sourceCustomerId": {
"type": "string",
"description": "Unique identifier to identify the customer who has run the job."
},
"targetCustomerId": {
"type": "string",
"description": "Unique identifier to identify the customer for which the job was run."
},
"instanceId": {
"type": "number",
"description": "Unique identifier to identify the instance of the job."
},
"jobExecutionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobExecutionStatusObject"
},
"description": "Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job."
},
"latestExecutionStatus": {
"type": "string",
"description": "Indicates the most recent status (`STARTING`, `STARTED`, `COMPLETED`, `FAILED`) of the job at the time of invocation."
},
"latestExecutionExitCode": {
"type": "string",
"enum": [
"UNKNOWN",
"COMPLETED",
"FAILED",
"STOPPED",
"COMPLETED_WITH_ERRORS"
],
"description": "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n"
},
"percentageComplete": {
"type": "integer",
"description": "Indicates the progress of the job."
},
"updatedCount": {
"type": "integer",
"description": "Number of job steps completed."
},
"advisoryCount": {
"type": "integer",
"description": "Number of job steps completed with advisories."
}
}
},
"ApplyLineKeyTemplateJobErrors": {
"type": "object",
"required": [
"trackingId"
],
"properties": {
"trackingId": {
"type": "string",
"description": "Unique identifier to track the HTTP requests."
},
"error": {
"$ref": "#/components/schemas/ErrorMessageObject",
"description": "Description of errors in the job."
}
}
},
"LineKeyTemplateAdvisoryTypes": {
"type": "object",
"properties": {
"moreSharedAppearancesEnabled": {
"type": "boolean",
"example": true,
"description": "Refine search to apply changes to devices that contain the warning \"More shared/virtual line appearances than shared/virtual lines requested\"."
},
"fewSharedAppearancesEnabled": {
"type": "boolean",
"example": true,
"description": "Refine search to apply changes to devices that contain the warning \"More shared/virtual lines requested than shared/virtual line appearances\"."
},
"moreMonitorAppearancesEnabled": {
"type": "boolean",
"example": true,
"description": "Refine search to apply changes to devices that contain the warning \"More monitored line appearances than monitored lines in the user's monitoring list\"."
},
"moreCPEAppearancesEnabled": {
"type": "boolean",
"example": true,
"description": "Refine search to apply changes to devices that contain the warning \"More call park extension line appearances than call park extensions in user's monitoring list\"."
},
"moreModeManagementAppearancesEnabled": {
"type": "boolean",
"example": true,
"description": "Refine search to apply changes to devices that contain the warning \"More mode management lines configured for the device\". The default value is false."
}
}
},
"PostApplyLineKeyTemplateRequest": {
"type": "object",
"required": [
"action",
"templateId"
],
"properties": {
"action": {
"type": "string",
"enum": [
"APPLY_TEMPLATE",
"APPLY_DEFAULT_TEMPLATES"
],
"description": "Line key Template action to perform.\n * `APPLY_TEMPLATE` - Used to apply LinekeyTemplate to devices.\n * `APPLY_DEFAULT_TEMPLATES` - Used to reset devices to its default Linekey Template configurations.\n"
},
"templateId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL1VTL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9kNDUzM2MwYi1hZGRmLTRjODUtODk0YS1hZTVkOTAyYzAyMDM=",
"description": "`templateId` is required for `APPLY_TEMPLATE` action."
},
"locationIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Used to search for devices only in the given locations."
},
"excludeDevicesWithCustomLayout": {
"type": "boolean",
"description": "Indicates whether to exclude devices with custom layout."
},
"includeDeviceTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Include devices only with these tags."
},
"excludeDeviceTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Exclude devices with these tags."
},
"advisoryTypes": {
"$ref": "#/components/schemas/LineKeyTemplateAdvisoryTypes",
"description": "Refine search with advisories."
}
}
},
"PostLineKeyTemplateRequest": {
"type": "object",
"required": [
"templateName",
"deviceModel",
"lineKeys"
],
"properties": {
"templateName": {
"type": "string",
"example": "template for 8845",
"description": "Name of the Line Key Template."
},
"deviceModel": {
"type": "string",
"example": "DMS Cisco 8845",
"description": "The model of the device for which the Line Key Template is applicable. The corresponding device model display name sometimes called the product name, can also be used to specify the model."
},
"userReorderEnabled": {
"type": "boolean",
"example": true,
"description": "User Customization Enabled."
},
"lineKeys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProgrammableLineKeys"
},
"description": "Contains a mapping of Line Keys and their corresponding actions."
}
}
},
"ProgrammableLineKeys": {
"type": "object",
"required": [
"lineKeyIndex",
"lineKeyType",
"sharedLineIndex"
],
"properties": {
"lineKeyIndex": {
"type": "number",
"example": 2,
"description": "An index representing a Line Key. Index starts from 1 representing the first key on the left side of the phone."
},
"lineKeyType": {
"$ref": "#/components/schemas/LineKeyType",
"description": "The action that would be performed when the Line Key is pressed."
},
"lineKeyLabel": {
"type": "string",
"example": "Help Line",
"description": "This is applicable only when the lineKeyType is `SPEED_DIAL`."
},
"lineKeyValue": {
"type": "string",
"example": "5646",
"description": "Applicable only when the `lineKeyType` is `SPEED_DIAL`. Value must be a valid telephone number, ext, or SIP URI (format: `user@host` using A-Z,a-z,0-9,-_ .+ for `user` and `host`)."
},
"sharedLineIndex": {
"type": "number",
"example": 4,
"description": "Shared line index is the line label number of the shared or virtual line assigned in the configured lines. Since you can add multiple appearances of the same shared or virtual line on a phone, entering the index number assigns the respective line to a line key. This is applicable only when the `lineKeyType` is SHARED_LINE. `sharedLineIndex` starts at 1 and increments by one for each shared line."
}
}
},
"PutLineKeyTemplateRequest": {
"type": "object",
"required": [
"lineKeys"
],
"properties": {
"userReorderEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the user can reorder the line keys."
},
"lineKeys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProgrammableLineKeys"
},
"description": "List of line keys that are being updated."
}
}
},
"lineKeyTemplatesResponse": {
"type": "object",
"required": [
"id",
"templateName",
"deviceModel",
"modelDisplayName"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL1VTL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9kNDUzM2MwYi1hZGRmLTRjODUtODk0YS1hZTVkOTAyYzAyMDM=",
"description": "Unique identifier for the Line Key Template."
},
"templateName": {
"type": "string",
"example": "template for 8845",
"description": "Name of the Line Key Template."
},
"deviceModel": {
"type": "string",
"example": "DMS Cisco 8845",
"description": "The Device Model for which the Line Key Template is applicable."
},
"modelDisplayName": {
"type": "string",
"example": "Cisco 8845",
"description": "The friendly display name used to represent the device model in Control Hub."
}
}
},
"GetThirdPartyDeviceObject": {
"type": "object",
"required": [
"manufacturer",
"managedBy",
"id",
"ip",
"model",
"upgradeChannelEnabled"
],
"properties": {
"manufacturer": {
"type": "string",
"example": "THIRD_PARTY",
"description": "Manufacturer of the device."
},
"managedBy": {
"type": "string",
"example": "CUSTOMER",
"description": "Device manager(s)."
},
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3",
"description": "A unique identifier for the device."
},
"ip": {
"type": "string",
"example": "100.110.120.130",
"description": "The current IP address of the device."
},
"mac": {
"type": "string",
"example": "11223344AAFF",
"description": "The unique address for the network adapter."
},
"model": {
"type": "string",
"example": "DMS Cisco 8811",
"description": "A model type of the device."
},
"activationState": {
"$ref": "#/components/schemas/ActivationStates",
"description": "Activation state of the device. This field is only populated for a device added by a unique activation code generated by Control Hub for use with Webex."
},
"description": {
"type": "array",
"items": {
"type": "string",
"example": "device description"
},
"description": "Comma-separated array of tags used to describe the device."
},
"upgradeChannelEnabled": {
"type": "boolean",
"example": true,
"description": "Enabled / disabled status of the upgrade channel."
},
"owner": {
"type": "object",
"required": [
"sipUserName"
],
"properties": {
"sipUserName": {
"type": "string",
"example": "392829",
"description": "SIP authentication user name for the owner of the device."
},
"linePort": {
"type": "string",
"example": "lg1_sias10_cpapi16004_LGU@64941297.int10.bcld.webex.com",
"description": "Identifies a device endpoint in standalone mode or a SIP URI public identity in IMS mode."
}
}
},
"proxy": {
"type": "object",
"properties": {
"outboundProxy": {
"type": "string",
"example": "hs17.hosted-int.bcld.webex.com",
"description": "Outgoing server which the phone should use for all SIP requests. Not set if the response has no body."
}
}
}
}
},
"PutThirdPartyDevice": {
"type": "object",
"required": [
"sipPassword"
],
"properties": {
"sipPassword": {
"type": "string",
"example": "Test4Password123&",
"description": "Password to be updated."
}
}
},
"DeviceLayout": {
"type": "object",
"required": [
"layoutMode",
"lineKeys"
],
"properties": {
"layoutMode": {
"$ref": "#/components/schemas/LayoutMode",
"description": "Defines the layout mode of the device, i.e. DEFAULT or CUSTOM."
},
"userReorderEnabled": {
"type": "boolean",
"example": true,
"description": "If `true`, user customization is enabled."
},
"lineKeys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProgrammableLineKeys"
},
"description": "Contains a mapping of Line Keys and their corresponding actions."
},
"kemModuleType": {
"$ref": "#/components/schemas/KemModuleType",
"description": "Type of KEM module."
},
"kemKeys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/KEMKeys"
},
"description": "Contains a mapping of KEM Keys and their corresponding actions. For KEM keys not included in the request, they will be set to OPEN."
}
}
},
"KEMKeys": {
"type": "object",
"required": [
"kemModuleIndex",
"kemKeyIndex",
"kemKeyType",
"sharedLineIndex"
],
"properties": {
"kemModuleIndex": {
"type": "number",
"example": 1,
"description": "An index representing a KEM Module. The Index starts from 1 representing the first KEM Module."
},
"kemKeyIndex": {
"type": "number",
"example": 1,
"description": "An index representing a KEM Key. The Index starts from 1 representing the first key on the left side of the phone."
},
"kemKeyType": {
"$ref": "#/components/schemas/LineKeyType",
"description": "The action that would be performed when the KEM Key is pressed."
},
"kemKeyLabel": {
"type": "string",
"example": "Office",
"description": "Applicable only when the kemKeyType is `SPEED_DIAL`."
},
"kemKeyValue": {
"type": "string",
"example": "213457",
"description": "Applicable only when the `lineKeyType` is `SPEED_DIAL`. Value must be a valid telephone number, ext, or SIP URI (format: `user@host` using A-Z,a-z,0-9,-_ .+ for `user` and `host`)."
},
"sharedLineIndex": {
"type": "number",
"example": 4,
"description": "Shared line index is the line label number of the shared or virtual line assigned in the configured lines. Since you can add multiple appearances of the same shared or virtual line on a phone, entering the index number assigns the respective line to a line key. This is applicable only when the `lineKeyType` is SHARED_LINE. `sharedLineIndex` starts at 1 and increments by one for each shared line."
}
}
},
"LayoutMode": {
"type": "string",
"enum": [
"DEFAULT",
"CUSTOM"
],
"description": " * `DEFAULT` - Default layout mode when a new device is added.\n * `CUSTOM` - Enables a device to have its custom layout.\n"
},
"RebuildPhonesPostRequest": {
"type": "object",
"required": [
"locationId"
],
"properties": {
"locationId": {
"type": "string",
"description": "Unique identifier of the location."
}
}
},
"RebuildPhonesList": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RebuildPhonesJob"
},
"description": "List of rebuild phones jobs."
}
}
},
"RebuildPhonesJob": {
"type": "object",
"required": [
"name",
"id",
"trackingId",
"sourceUserId",
"sourceCustomerId",
"targetCustomerId",
"instanceId",
"latestExecutionStatus",
"target",
"percentageComplete"
],
"properties": {
"name": {
"type": "string",
"example": "rebuildphones",
"description": "Name of the job which in this case, is `rebuildphones`."
},
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wNjZkOTQzNC1kODEyLTQzODItODVhMC00MjBlOTFlODg3ZTY",
"description": "Unique identifier of the job."
},
"trackingId": {
"type": "string",
"example": "ROUTERGW_1d458245-ee34-48c8-8ed6-92ea16ed48aa",
"description": "Unique identifier to track the flow of HTTP requests."
},
"sourceUserId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS81MDRhZmQ1YS0zODRiLTQ0NjYtYTJlNC05Y2ExZjUwMDRlYWQ",
"description": "Unique identifier of the user who has run the job."
},
"sourceCustomerId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE",
"description": "Unique identifier of the customer who has run the job."
},
"targetCustomerId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE",
"description": "Unique identifier of the customer for which the job was run."
},
"instanceId": {
"type": "number",
"example": 428989,
"description": "Unique identifier to identify the instance of the job."
},
"jobExecutionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobExecutionStatusObject"
},
"description": "Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job."
},
"latestExecutionStatus": {
"$ref": "#/components/schemas/LatestExecutionStatus",
"description": "Indicates the most recent status of the job at the time of invocation."
},
"latestExecutionExitCode": {
"type": "string",
"enum": [
"UNKNOWN",
"COMPLETED",
"FAILED",
"STOPPED",
"COMPLETED_WITH_ERRORS"
],
"description": "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n"
},
"target": {
"type": "string",
"example": "LOCATION",
"description": "Indicates the target entity, i.e. LOCATION."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzQ0Y2UwNDBhLTEzNmMtNDc3NS1hMjIzLTY5OTczYmEyYWNhYw",
"description": "Unique identifier of a location."
},
"percentageComplete": {
"type": "integer",
"example": 10,
"description": "Indicates the progress of the job."
},
"deviceCount": {
"type": "number",
"example": 10,
"description": "Count of number of devices rebuilt."
}
}
},
"EnhancedMulticastObject": {
"type": "object",
"required": [
"multicastList"
],
"properties": {
"xmlAppUrl": {
"type": "string",
"example": "http://127.0.0.1:8080/",
"description": "Specify the URL for the XML application."
},
"multicastList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MulticastObject"
},
"description": "Specify up to 10 multicast group URLs each with a unique listening port, an XML application URL, and a timeout."
}
}
},
"MulticastObject": {
"type": "object",
"required": [
"hostAndPort",
"hasXmlAppUrl"
],
"properties": {
"hostAndPort": {
"type": "string",
"example": "224.0.0.0:22",
"description": "Specify the multicast group URL and listening port."
},
"hasXmlAppUrl": {
"type": "boolean",
"example": true,
"description": "Specify whether the multicast group URL has an XML application URL."
},
"xmlAppTimeout": {
"type": "number",
"example": 10,
"description": "Specify the timeout for the XML application."
}
}
},
"listBackgroundImagesObject": {
"type": "object",
"required": [
"backgroundImageUrl",
"fileName"
],
"properties": {
"backgroundImageUrl": {
"type": "string",
"example": "\"/dms/Cisco_Phone_Background/background001\"",
"description": "The URL of the image file."
},
"fileName": {
"type": "string",
"example": "CompanyLogoBlue",
"description": "The name of the image file."
}
}
},
"deleteImageResponseObject": {
"type": "object",
"required": [
"fileName",
"result"
],
"properties": {
"fileName": {
"type": "string",
"example": "CompanyLogoBlue",
"description": "The name of the image file."
},
"result": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "number",
"example": 400,
"description": "The status of the deletion."
},
"error": {
"type": "object",
"required": [
"message",
"errorCode"
],
"properties": {
"message": {
"type": "string",
"example": "The image could not be deleted.",
"description": "The error message."
},
"errorCode": {
"type": "number",
"example": 4305,
"description": "The error code."
}
},
"description": "The error message if the deletion failed."
}
},
"description": "The result of the deletion."
}
}
},
"deleteImageResponseSuccessObject": {
"type": "object",
"required": [
"fileName",
"result"
],
"properties": {
"fileName": {
"type": "string",
"example": "CompanyLogoBlue",
"description": "The name of the image file."
},
"result": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "number",
"example": 200,
"description": "The status of the deletion."
}
},
"description": "The result of the deletion."
}
}
},
"deleteImageRequestObject": {
"type": "object",
"required": [
"fileName"
],
"properties": {
"fileName": {
"type": "string",
"example": "CompanyLogoBlue",
"description": "The name of the image file to be deleted."
},
"forceDelete": {
"type": "boolean",
"example": true,
"description": "Flag to force delete the image. When `forceDelete` = true, if any device, location, or org level custom background URL is configured with the `backgroundImageURL` containing the filename being deleted, the background image is set to `None`."
}
}
},
"userDeviceCount": {
"type": "object",
"required": [
"totalDeviceCount",
"applicationsCount"
],
"properties": {
"totalDeviceCount": {
"type": "number",
"example": 3,
"description": "The total count of devices associated with the user as a sum of:\n\n- Count of total primary physical devices.\n\n- Count of Webex-Team system device endpoints.\n\n- Count of 1 for any or all applications present."
},
"applicationsCount": {
"type": "number",
"example": 4,
"description": "The total count of applications associated with the user."
}
}
},
"DeviceDynamicSettingsValidationSchemaGet": {
"type": "object",
"example": {
"tags": [
{
"familyOrModelDisplayName": "Poly",
"tag": "%G711U_ORDER%",
"friendlyName": "voice.codecPref.G711Mu",
"tooltip": "Tag tooltip.",
"level": [
"location",
"device"
],
"validationRule": {
"type": "int",
"min": 0,
"max": 10,
"increment": 1
}
}
]
},
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceTag"
},
"description": "Array of device settings tags with their validation rules."
}
}
},
"DeviceDynamicSettingsSettingsGroupsGet": {
"type": "object",
"example": {
"settingsGroups": [
{
"path": "Voice.Codec Preferences",
"friendlyName": "voice.codecPref.G711Mu",
"tab": "Poly",
"familyOrModelDisplayName": "Poly",
"tags": [
{
"tagBlock": [
"%G711U_ORDER%"
]
}
]
}
],
"settingsTabs": [
"Poly",
"MPP"
]
},
"properties": {
"settingsGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceSettingsGroup"
},
"description": "Array of settings groups defining structure and association of tags."
},
"settingsTabs": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of settings tabs names. Can be filtered using the `includeSettingsType` parameter."
}
}
},
"DeviceTag": {
"type": "object",
"properties": {
"familyOrModelDisplayName": {
"type": "string",
"description": "The family or model name of the device to which these settings apply.",
"example": "Poly"
},
"tag": {
"type": "string",
"description": "The unique identifier for the setting.",
"example": "%G711U_ORDER%"
},
"friendlyName": {
"type": "string",
"description": "A user-friendly name for the setting. It helps to correlate the tag with the UI in settings groups.",
"example": "voice.codecPref.G711Mu"
},
"tooltip": {
"type": "string",
"description": "Explanatory text for the setting.",
"example": "Tag tooltip."
},
"alert": {
"type": "string",
"description": "Alert message related to this setting, if applicable.",
"example": "Alert text."
},
"level": {
"type": "array",
"items": {
"type": "string"
},
"description": "The levels at which this setting can be configured. When fetching tags or updating tags, the tag should be allowed at the level the request is made for.",
"example": [
"organization",
"location",
"device"
]
},
"validationRule": {
"$ref": "#/components/schemas/ValidationRule"
}
}
},
"DeviceSettingsGroup": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Path of the settings group. Creates an easily navigable settings hierarchy.",
"example": "Voice.Codec Preferences"
},
"friendlyName": {
"type": "string",
"description": "Friendly name of the settings group.",
"example": "voice.codecPref.G711Mu"
},
"tab": {
"type": "string",
"description": "Tab name associated with the settings group.",
"example": "Poly"
},
"familyOrModelDisplayName": {
"type": "string",
"description": "Family or model display name associated with the settings group.",
"example": "Poly"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceSettingsGroupTag"
},
"description": "List of `tagBlock` objects associated with the settings group."
}
}
},
"DeviceSettingsGroupTag": {
"type": "object",
"properties": {
"tagBlock": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of tags associated with the settings group.",
"example": [
"%G711U_ORDER%"
]
}
}
},
"ValidationRule": {
"type": "object",
"description": "Validation rules and constraints for device setting values.",
"properties": {
"type": {
"type": "string",
"description": "The data type of the setting. Possible values are `string`, `integer`, `boolean`, `enum` , `password` or `network`.",
"example": "\"int\""
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "Possible values for `enum` or `boolean` types.",
"example": [
"0",
"1",
"2",
"NumberOnly"
]
},
"min": {
"type": "integer",
"description": "Minimum value for numeric types.",
"example": 0
},
"max": {
"type": "integer",
"description": "Maximum value for numeric types.",
"example": 10
},
"increment": {
"type": "integer",
"description": "Increment value for numeric types.",
"example": 1
},
"regex": {
"type": "string",
"description": "Regular expression pattern for string validation.",
"example": "[A-Za-z0-9]+"
},
"maxLength": {
"type": "integer",
"description": "Maximum length for string values.",
"example": 255
},
"validationHint": {
"type": "string",
"description": "Hint to display to users about validation requirements.",
"example": "5-60"
}
}
},
"CustomerDeviceDynamicSettingsListPostRequest": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"description": "Optional array of device tag identifiers to request settings for. Each identifier must have a length between 1 and 64 characters.",
"minItems": 0
}
}
},
"CustomerDeviceDynamicSettingsListPostResponse": {
"type": "object",
"example": {
"tags": [
{
"familyOrModelDisplayName": "Poly",
"tag": "%DO_MENU_ITEM_BACKGROUND%",
"value": "#RRGGBB",
"parentValue": "#FFFFFF",
"parentLevel": "ORGANIZATION"
}
],
"lastUpdateTime": 1651396800000,
"updateInProgress": false
},
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerDevicePostTag"
},
"description": "Array of device setting values matching the requested tags."
},
"lastUpdateTime": {
"type": "integer",
"format": "int64",
"description": "Timestamp of the last update to these settings."
},
"updateInProgress": {
"type": "boolean",
"description": "Flag indicating if an update to these settings is currently in progress."
}
}
},
"CustomerDevicePostTag": {
"type": "object",
"properties": {
"familyOrModelDisplayName": {
"type": "string",
"description": "The `familyOrModelDisplayName` of the device.",
"example": "Poly"
},
"tag": {
"type": "string",
"description": "The unique identifier for the setting.",
"example": "%G711U_ORDER%"
},
"value": {
"type": "string",
"description": "The current value of the setting at `ORGANIZATION` level. If the tag value is not set at the `ORGANIZATION` level, this field will not be included in the response.",
"example": "4"
},
"parentValue": {
"type": "string",
"description": "The value inherited from the immediate parent level above `ORGANIZATION`. It can be `SYSTEM_DEFAULT`, `REGIONAL_DEFAULT`, or `ORGANIZATION`, depending on which level the setting is actually configured at. If there is no parent level for this tag, this field will not be included in the response.",
"example": "3"
},
"parentLevel": {
"$ref": "#/components/schemas/DynamicDeviceSettingsCustomerParentLevel"
}
}
},
"DynamicDeviceSettingsCustomerParentLevel": {
"type": "string",
"enum": [
"SYSTEM_DEFAULT",
"REGIONAL_DEFAULT",
"ORGANIZATION"
],
"description": "The level from which the tag's parent value is inherited. If there is no parent level for this tag, this field will not be included in the response."
},
"LocationDeviceDynamicSettingsListPostRequest": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"description": "Optional array of device tag identifiers to request settings for. Each identifier must have a length between 1 and 64 characters.",
"minItems": 0
}
}
},
"LocationDeviceDynamicSettingsListPostResponse": {
"type": "object",
"example": {
"tags": [
{
"familyOrModelDisplayName": "Poly",
"tag": "%G711U_ORDER%",
"value": "4",
"parentValue": "3",
"parentLevel": "ORGANIZATION"
}
],
"lastUpdateTime": 1651396800000,
"updateInProgress": false
},
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LocationDevicePostResponseTag"
},
"description": "Array of device setting values matching the requested tags."
},
"lastUpdateTime": {
"type": "integer",
"format": "int64",
"description": "Timestamp of the last update to these settings."
},
"updateInProgress": {
"type": "boolean",
"description": "Flag indicating if an update to these settings is currently in progress."
}
}
},
"LocationDevicePostResponseTag": {
"type": "object",
"properties": {
"familyOrModelDisplayName": {
"type": "string",
"description": "The `familyOrModelDisplayName` of the device.",
"example": "Poly"
},
"tag": {
"type": "string",
"description": "The unique identifier for the setting.",
"example": "%G711U_ORDER%"
},
"value": {
"type": "string",
"description": "The current value of the setting at `LOCATION` level. If the tag value is not set at the `LOCATION` level, this field will not be included in the response.",
"example": "4"
},
"parentValue": {
"type": "string",
"description": "The value inherited from the immediate parent level above `LOCATION`. It can be `SYSTEM_DEFAULT`, `REGIONAL_DEFAULT`, `ORGANIZATION`, or `LOCATION`, depending on which level the setting is actually configured at. If there is no parent level for this tag, this field will not be included in the response.",
"example": "3"
},
"parentLevel": {
"$ref": "#/components/schemas/LocationParentLevel"
}
}
},
"LocationParentLevel": {
"type": "string",
"enum": [
"SYSTEM_DEFAULT",
"REGIONAL_DEFAULT",
"ORGANIZATION",
"LOCATION"
],
"description": "The level from which the tag's parent value is inherited. If there is no parent level for this tag, this field will not be included in the response."
},
"DeviceDynamicSettingsListPostRequest": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional array of tag identifiers representing specific settings to fetch. If omitted or provided as an empty array, all settings for the device will be returned.",
"minItems": 0
}
}
},
"DeviceDynamicSettingsListPostResponse": {
"type": "object",
"required": [
"tags"
],
"example": {
"tags": [
{
"familyOrModelDisplayName": "Poly",
"tag": "%G711U_ORDER%",
"value": "4",
"parentValue": "3",
"parentLevel": "ORGANIZATION"
}
],
"lastUpdateTime": 1651396800000
},
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DevicePostResponseTag"
},
"description": "Array of device setting values matching the requested tags."
},
"lastUpdateTime": {
"type": "integer",
"format": "int64",
"description": "Timestamp of the last update to these settings."
}
}
},
"DeviceDynamicSettingsPutRequest": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DevicePutItem"
},
"description": "Optional array of `tag` identifiers representing specific settings to update. If omitted or provided as an empty array, the request will have no effect.",
"minItems": 0
}
}
},
"DevicePostResponseTag": {
"type": "object",
"required": [
"familyOrModelDisplayName",
"tag"
],
"properties": {
"familyOrModelDisplayName": {
"type": "string",
"description": "The display name of the device family or model associated with the returned tag.",
"example": "Poly"
},
"tag": {
"type": "string",
"description": "The unique identifier for the device setting.",
"example": "%G711U_ORDER%"
},
"value": {
"type": "string",
"description": "The current value of the setting at device level. If the tag value is not set at the device level, this field will not be included in the response.",
"example": "4"
},
"parentValue": {
"type": "string",
"description": "The setting value at the next available `parentLevel`. It is used if `value` is not set and is omitted when no parent level exists for the tag.",
"example": "3"
},
"parentLevel": {
"$ref": "#/components/schemas/DeviceParentLevel"
}
}
},
"DeviceParentLevel": {
"type": "string",
"enum": [
"SYSTEM_DEFAULT",
"REGIONAL_DEFAULT",
"ORGANIZATION",
"LOCATION"
],
"description": "The level from which the tag's parent value is inherited. If there is no parent level for this tag, this field will not be included in the response."
},
"DevicePutItem": {
"type": "object",
"required": [
"tag",
"action"
],
"properties": {
"tag": {
"type": "string",
"description": "The unique identifier for the setting to be updated.",
"example": "%G711U_ORDER%",
"minLength": 1,
"maxLength": 64
},
"action": {
"$ref": "#/components/schemas/Action"
},
"value": {
"type": "string",
"description": "The new value to set for the setting. This field is required when `action` is `SET` and ignored otherwise.",
"example": "4",
"minLength": 1,
"maxLength": 256
}
}
},
"Action": {
"type": "string",
"enum": [
"SET",
"CLEAR"
],
"description": "The action to perform on the setting. When action is `SET`, `tag` is updated to specified value. When action is `CLEAR`, the `tag` value at device level is removed, and the device will inherit the value from the parent level, if it exists.",
"example": "SET"
},
"PostDynamicDeviceSettingsJobResponse": {
"type": "object",
"required": [
"name",
"id",
"trackingId",
"sourceUserId",
"sourceCustomerId",
"targetCustomerId",
"instanceId",
"jobExecutionStatus",
"latestExecutionStatus",
"latestExecutionExitCode",
"target",
"percentageComplete"
],
"example": {
"name": "dynamicdevicesettings",
"id": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wNjZkOTQzNC1kODEyLTQzODItODVhMC00MjBlOTFlODg3ZTY",
"trackingId": "ROUTERGW_1d458245-ee34-48c8-8ed6-92ea16ed48aa",
"sourceUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS81MDRhZmQ1YS0zODRiLTQ0NjYtYTJlNC05Y2ExZjUwMDRlYWQ",
"sourceCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE",
"targetCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE",
"instanceId": 428989,
"jobExecutionStatus": [
{
"id": 0,
"startTime": "2025-05-13T10:59:44.106Z",
"lastUpdated": "2025-05-13T10:59:44.106Z",
"statusMessage": "STARTED",
"exitCode": "UNKNOWN",
"createdTime": "2025-05-13T10:50:01.352Z",
"timeElapsed": "PT11.476S"
}
],
"latestExecutionStatus": "STARTED",
"latestExecutionExitCode": "UNKNOWN",
"target": "CUSTOMER",
"locationId": "",
"percentageComplete": 100
},
"properties": {
"name": {
"type": "string",
"example": "dynamicdevicesettings",
"description": "Name of the job which in this case, is `dynamicdevicesettings`."
},
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wNjZkOTQzNC1kODEyLTQzODItODVhMC00MjBlOTFlODg3ZTY",
"description": "Unique identifier of the job."
},
"trackingId": {
"type": "string",
"example": "ROUTERGW_1d458245-ee34-48c8-8ed6-92ea16ed48aa",
"description": "Unique identifier to track the flow of HTTP requests."
},
"sourceUserId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS81MDRhZmQ1YS0zODRiLTQ0NjYtYTJlNC05Y2ExZjUwMDRlYWQ",
"description": "Unique identifier of the user who has run the job."
},
"sourceCustomerId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE",
"description": "Unique identifier of the customer who has run the job."
},
"targetCustomerId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE",
"description": "Unique identifier of the customer for which the job was run."
},
"instanceId": {
"type": "number",
"example": 428989,
"description": "Unique identifier to identify the instance of the job."
},
"jobExecutionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobExecutionStatusObject"
},
"description": "Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job."
},
"latestExecutionStatus": {
"$ref": "#/components/schemas/LatestExecutionStatus"
},
"latestExecutionExitCode": {
"type": "string",
"enum": [
"UNKNOWN",
"COMPLETED",
"FAILED",
"STOPPED",
"COMPLETED_WITH_ERRORS"
],
"description": "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n"
},
"target": {
"type": "string",
"enum": [
"CUSTOMER",
"LOCATION"
],
"example": "LOCATION",
"description": "Indicates the target entity."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzQ0Y2UwNDBhLTEzNmMtNDc3NS1hMjIzLTY5OTczYmEyYWNhYw",
"description": "Unique identifier of a location."
},
"locationName": {
"type": "string",
"example": "Brampton",
"description": "Name of the location. Included only when `target` is `LOCATION`."
},
"percentageComplete": {
"type": "integer",
"example": 10,
"description": "Indicates the progress of the job."
}
}
},
"LatestExecutionStatus": {
"type": "string",
"enum": [
"STARTING",
"STARTED",
"COMPLETED",
"FAILED"
],
"description": " * `STARTING` - Indicates the job has started.\n * `STARTED` - Indicates the job is in progress.\n * `COMPLETED` - Indicates the job has completed.\n * `FAILED` - Indicates the job has failed.\n"
},
"JobExecutionStatusObject": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"example": 436272,
"description": "Unique identifier that identifies each instance of the job."
},
"startTime": {
"type": "string",
"example": "2025-05-13T10:59:44.106Z",
"description": "Step execution start time in UTC format."
},
"endTime": {
"type": "string",
"example": "2025-05-13T10:59:44.692Z",
"description": "Step execution end time in UTC format."
},
"lastUpdated": {
"type": "string",
"example": "2025-05-13T10:59:44.854Z",
"description": "Last updated time (in UTC format) post one of the step execution completion."
},
"statusMessage": {
"type": "string",
"example": "STARTING",
"description": "Displays status for overall steps that are part of the job."
},
"exitCode": {
"type": "string",
"example": "UNKNOWN",
"description": "Exit Code for a job."
},
"createdTime": {
"type": "string",
"example": "2024-03-13T14:57:04.678Z",
"description": "Job creation time in UTC format."
},
"timeElapsed": {
"type": "string",
"example": "PT0S",
"description": "Time lapsed since the job execution started."
},
"stepExecutionStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/stepExecutionStatusesObject"
},
"description": "Status of each step within a job."
}
}
},
"JobExecutionStatusObject1": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Unique identifier that identifies each instance of the job."
},
"lastUpdated": {
"type": "string",
"description": "Last updated time (in UTC format) post one of the step execution completion."
},
"statusMessage": {
"type": "string",
"description": "Displays status for overall steps that are part of the job."
},
"exitCode": {
"type": "string",
"description": "Exit Code for a job."
},
"createdTime": {
"type": "string",
"description": "Job creation time in UTC format."
},
"timeElapsed": {
"type": "string",
"description": "Time lapsed since the job execution started."
}
}
},
"stepExecutionStatusesObject": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"example": 1998857,
"description": "Unique identifier that identifies each step in a job."
},
"startTime": {
"type": "string",
"example": "2024-03-13T03:58:36.886Z",
"description": "Step execution start time in UTC format."
},
"endTime": {
"type": "string",
"example": "2024-03-13T03:58:48.471Z",
"description": "Step execution end time in UTC format."
},
"lastUpdated": {
"type": "string",
"example": "2024-03-13T03:58:48.472Z",
"description": "Last updated time for a step in UTC format."
},
"statusMessage": {
"type": "string",
"example": "COMPLETED",
"description": "Displays the status of a step."
},
"exitCode": {
"type": "string",
"example": "COMPLETED",
"description": "Exit Code for a step."
},
"name": {
"type": "string",
"example": "dynamicdevicesettingsUpdate",
"description": "Name of different steps the job goes through."
},
"timeElapsed": {
"type": "string",
"example": "PT11.585S",
"description": "Time lapsed since the step execution started."
}
}
},
"PostDynamicSettingsUpdateStartJobRequest": {
"type": "object",
"required": [
"tags"
],
"properties": {
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"description": "If present, the requested settings will be updated to devices under this location."
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DynamicSettingsUpdateJobDevicePostItem"
},
"description": "Array of tag identifiers for settings to be updated. Each setting is identified by a `familyOrModelDisplayName` and `tag`. Supports updating multiple settings across different device families in a single request.",
"minItems": 1
}
}
},
"DynamicSettingsUpdateJobDevicePostItem": {
"type": "object",
"required": [
"familyOrModelDisplayName",
"tag",
"action"
],
"properties": {
"familyOrModelDisplayName": {
"type": "string",
"description": "The `familyOrModelDisplayName` of the device to which the tag applies. This value must exist in the validation schema.",
"example": "Poly",
"minLength": 1,
"maxLength": 40
},
"tag": {
"type": "string",
"description": "The unique identifier for the setting to be updated.",
"example": "%G711U_ORDER%",
"minLength": 1,
"maxLength": 64
},
"action": {
"$ref": "#/components/schemas/Action"
},
"value": {
"type": "string",
"description": "The new value to set for the setting. This field is required when `action` is `SET` and ignored otherwise.",
"example": "4",
"minLength": 1,
"maxLength": 256
}
}
},
"DynamicDeviceSettingsJobListResponse": {
"type": "object",
"required": [
"items"
],
"example": {
"items": [
{
"name": "dynamicdevicesettings",
"id": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wZTJjNmI5NC1hNDdlLTQxZGUtODE5ZS04YTcwNTZjMTc5MDk",
"trackingId": "NA_a9ef6908-60cf-40e6-b56f-461abffd6fa3",
"sourceUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"sourceCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M",
"targetCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M",
"instanceId": 0,
"jobExecutionStatus": [],
"latestExecutionStatus": "COMPLETED",
"latestExecutionExitCode": "COMPLETED",
"target": "LOCATION",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgwZmUxMzdkLTg5NDgtNDlhYS1iODdiLTk4MGMxN2I2YzdiYg",
"percentageComplete": 100
}
]
},
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostDynamicDeviceSettingsJobResponse"
},
"description": "Lists all jobs for the customer of type `dynamicdevicesettings` in order of most recent one to oldest one irrespective of its status."
}
}
},
"ErrorResponseObject": {
"type": "object",
"example": {
"items": [
{
"itemNumber": 0,
"error": {
"key": "error.key",
"message": [
{
"description": "Error description",
"code": "1001",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMzZjBlZDFiLWQ1YjctNGI4Mi1iMzIzLTg4ZTFmODMzNGNmMw"
}
]
},
"trackingId": "ROUTER_62F66055-8D70-01BB-0137-AC10A8310137"
}
]
},
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemObject"
},
"description": "Array of error items for failed operations.",
"example": [
{
"itemNumber": 0,
"trackingId": "ROUTER_62F66055-8D70-01BB-0137-AC10A8310137"
}
]
}
}
},
"ItemObject": {
"type": "object",
"properties": {
"itemNumber": {
"type": "number",
"description": "Index of error number."
},
"trackingId": {
"type": "string",
"description": "Unique identifier to track the HTTP requests."
},
"error": {
"$ref": "#/components/schemas/ErrorObject"
}
}
},
"ErrorObject": {
"type": "object",
"description": "Error details object containing error information.",
"properties": {
"key": {
"type": "string",
"description": "HTTP error code."
},
"message": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorMessageObject"
},
"description": "Message string with further error information."
}
}
},
"ErrorMessageObject": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Error message."
},
"code": {
"type": "string",
"description": "Internal error code."
},
"locationId": {
"type": "string",
"description": "Error messages describing the location ID in which the error occurs."
}
}
},
"supportedDevicesObject": {
"type": "object",
"required": [
"devices",
"upgradeChannelList"
],
"example": {
"upgradeChannelList": [
"STABLE",
"STABLE_DELAY",
"PREVIEW",
"BETA",
"TESTING"
],
"devices": [
{
"model": "2N Customer Managed",
"displayName": "2N Customer Managed",
"type": "GENERIC_SIP",
"manufacturer": "THIRD_PARTY",
"managedBy": "CUSTOMER",
"supportedFor": [
"PEOPLE",
"PLACE"
],
"onboardingMethod": [
"MAC_ADDRESS"
],
"allowConfigureLayoutEnabled": false,
"numberOfLinePorts": 20,
"kemSupportEnabled": true,
"kemModuleCount": 1,
"kemLinesSupportEnabled": false,
"kemModuleType": [
"KEM_20_KEYS"
],
"upgradeChannelEnabled": false,
"additionalPrimaryLineAppearancesEnabled": false,
"basicEmergencyNomadicEnabled": false,
"customizedBehaviorsEnabled": false,
"allowConfigurePortsEnabled": false,
"customizableLineLabelEnabled": false,
"supportsLinePortReorderingEnabled": false,
"portNumberSupportEnabled": false,
"t38Enabled": false,
"callDeclinedEnabled": false,
"touchScreenPhone": false,
"numberOfLineKeyButtons": 0,
"deviceSettingsConfiguration": "NONE",
"allowHotelingHostEnabled": false,
"supportsLogCollection": "NONE",
"supportsApplyChangesEnabled": false,
"allowConfigureLinesEnabled": true,
"allowConfigurePhoneSettingsEnabled": false,
"supportsHotlineEnabled": false
},
{
"model": "DMS Polycom EE400",
"displayName": "Polycom EE400",
"familyDisplayName": "Poly",
"type": "GENERIC_SIP",
"manufacturer": "THIRD_PARTY",
"managedBy": "CISCO",
"supportedFor": [
"PEOPLE",
"PLACE"
],
"onboardingMethod": [
"MAC_ADDRESS"
],
"allowConfigureLayoutEnabled": false,
"numberOfLinePorts": 14,
"kemSupportEnabled": false,
"kemLinesSupportEnabled": false,
"upgradeChannelEnabled": false,
"additionalPrimaryLineAppearancesEnabled": true,
"basicEmergencyNomadicEnabled": false,
"customizedBehaviorsEnabled": true,
"allowConfigurePortsEnabled": false,
"customizableLineLabelEnabled": false,
"supportsLinePortReorderingEnabled": true,
"portNumberSupportEnabled": false,
"t38Enabled": false,
"callDeclinedEnabled": true,
"touchScreenPhone": false,
"numberOfLineKeyButtons": 0,
"deviceSettingsConfiguration": "WEBEX_CALLING_DYNAMIC_DEVICE_CONFIGURATION",
"allowHotelingHostEnabled": true,
"supportsLogCollection": "NONE",
"supportsApplyChangesEnabled": true,
"allowConfigureLinesEnabled": true,
"allowConfigurePhoneSettingsEnabled": true,
"supportsHotlineEnabled": true
}
]
},
"properties": {
"upgradeChannelList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpgradeChannelObject"
},
"description": "List of available upgrade channels.\n * `STABLE` - These are standard stable releases.\n * `STABLE_DELAY` - These are delayed stable releases.\n * `PREVIEW` - These are Preview/pre-release versions.\n * `BETA` - These are Beta testing versions.\n * `TESTING` - These are testing versions.\n"
},
"devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceObject"
},
"description": "List of supported devices."
}
}
},
"UpgradeChannelObject": {
"type": "string",
"enum": [
"STABLE",
"STABLE_DELAY",
"PREVIEW",
"BETA",
"TESTING"
]
},
"DeviceObject": {
"type": "object",
"required": [
"model",
"displayName",
"type",
"manufacturer",
"managedBy",
"supportedFor",
"onboardingMethod",
"allowConfigureLayoutEnabled",
"numberOfLinePorts",
"kemSupportEnabled",
"kemLinesSupportEnabled",
"upgradeChannelEnabled",
"additionalPrimaryLineAppearancesEnabled",
"basicEmergencyNomadicEnabled",
"customizedBehaviorsEnabled",
"allowConfigurePortsEnabled",
"customizableLineLabelEnabled",
"supportsLinePortReorderingEnabled",
"portNumberSupportEnabled",
"t38Enabled",
"callDeclinedEnabled",
"touchScreenPhone",
"numberOfLineKeyButtons",
"allowHotelingHostEnabled",
"supportsApplyChangesEnabled",
"allowConfigureLinesEnabled",
"allowConfigurePhoneSettingsEnabled",
"supportsHotlineEnabled"
],
"properties": {
"model": {
"type": "string",
"example": "2N Customer Managed",
"description": "Model name of the device."
},
"displayName": {
"type": "string",
"example": "2N Customer Managed",
"description": "Display name of the device."
},
"familyDisplayName": {
"type": "string",
"example": "Poly",
"description": "The display name of the device family."
},
"type": {
"$ref": "#/components/schemas/TypeObject"
},
"manufacturer": {
"$ref": "#/components/schemas/ManufacturerObject"
},
"managedBy": {
"$ref": "#/components/schemas/ManagedByObject"
},
"supportedFor": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SupportedForObject"
},
"description": "List of places the device is supported for."
},
"onboardingMethod": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OnboardingMethodObject"
},
"description": "Onboarding method."
},
"allowConfigureLayoutEnabled": {
"type": "boolean",
"description": "Enables / Disables layout configuration for devices."
},
"numberOfLinePorts": {
"type": "number",
"description": "Number of port lines."
},
"kemSupportEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether Kem support is enabled or not."
},
"kemModuleCount": {
"type": "number",
"description": "Module count."
},
"kemLinesSupportEnabled": {
"type": "boolean",
"description": "Enables / disables Kem lines support."
},
"kemModuleType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/KemModuleType"
},
"description": "Key expansion module type of the device."
},
"upgradeChannelEnabled": {
"type": "boolean",
"description": "Enables / Disables the upgrade channel."
},
"defaultUpgradeChannel": {
"type": "string",
"description": "The default upgrade channel."
},
"additionalPrimaryLineAppearancesEnabled": {
"type": "boolean",
"description": "Enables / disables the additional primary line appearances."
},
"basicEmergencyNomadicEnabled": {
"type": "boolean",
"description": "Enables / disables Basic emergency nomadic."
},
"customizedBehaviorsEnabled": {
"type": "boolean",
"description": "Enables / disables customized behavior support on devices."
},
"allowConfigurePortsEnabled": {
"type": "boolean",
"description": "Enables / disables configuring port support on device."
},
"customizableLineLabelEnabled": {
"type": "boolean",
"description": "Enables / disables customizable line label."
},
"supportsLinePortReorderingEnabled": {
"type": "boolean",
"description": "Enables / disables support line port reordering."
},
"portNumberSupportEnabled": {
"type": "boolean",
"description": "Enables / disables port number support."
},
"t38Enabled": {
"type": "boolean",
"description": "Enables / disables T.38."
},
"callDeclinedEnabled": {
"type": "boolean",
"description": "Enables / disables call declined."
},
"touchScreenPhone": {
"type": "boolean",
"description": "Supports touch screen on device."
},
"numberOfLineKeyButtons": {
"type": "number",
"description": "Number of line key buttons for a device."
},
"deviceSettingsConfiguration": {
"$ref": "#/components/schemas/DeviceSettingsConfigurationObject"
},
"allowHotelingHostEnabled": {
"type": "boolean",
"description": "Enables / disables hoteling host."
},
"supportsLogCollection": {
"$ref": "#/components/schemas/SupportsLogCollectionObject"
},
"supportsApplyChangesEnabled": {
"type": "boolean",
"description": "Enables / disables apply changes."
},
"allowConfigureLinesEnabled": {
"type": "boolean",
"description": "Enables / disables configure lines."
},
"allowConfigurePhoneSettingsEnabled": {
"type": "boolean",
"description": "Enables / disables configure phone settings."
},
"supportsHotlineEnabled": {
"type": "boolean",
"description": "Enables / disables hotline support."
},
"maxNumberOfLineAppearances": {
"type": "number",
"description": "Maximum number of line appearances available on the device."
}
}
},
"TypeObject": {
"type": "string",
"enum": [
"MPP",
"ATA",
"GENERIC_SIP",
"ESIM",
"DESK_PHONE"
],
"description": " * `MPP` - Cisco Multiplatform Phone\n * `ATA` - Analog Telephone Adapters\n * `GENERIC_SIP` - GENERIC Session Initiation Protocol\n * `ESIM` - Esim Supported Webex Go\n * `DESK_PHONE` - Desk Phone\n"
},
"ManagedByObject": {
"type": "string",
"enum": [
"CISCO",
"CUSTOMER"
],
"description": " * `CISCO` - Devices managed by Cisco.\n * `CUSTOMER` - Devices managed by a customer that are approved by a Cisco account manager to be enabled for provisioning in the control hub.\n"
},
"ManufacturerObject": {
"type": "string",
"enum": [
"CISCO",
"THIRD_PARTY"
],
"description": " * `CISCO` - Devices manufactured by Cisco.\n * `THIRD_PARTY` - Devices manufactured by a third-party that are approved by a Cisco account manager to be enabled for provisioning in the control hub.\n"
},
"SupportedForObject": {
"type": "string",
"enum": [
"PEOPLE",
"PLACE"
]
},
"OnboardingMethodObject": {
"type": "string",
"enum": [
"MAC_ADDRESS",
"ACTIVATION_CODE",
"NONE"
]
},
"SupportsLogCollectionObject": {
"type": "string",
"enum": [
"NONE",
"CISCO_PRT",
"CISCO_ROOMOS"
],
"description": " * `NONE` - Devices which does not support log collection.\n * `CISCO_PRT` - Devices which supports Cisco PRT log collection.\n * `CISCO_ROOMOS` - Devices which supports Cisco RoomOS log collection.\n"
},
"DeviceSettingsConfigurationObject": {
"type": "string",
"enum": [
"WEBEX_CALLING_DEVICE_CONFIGURATION",
"WEBEX_DEVICE_CONFIGURATION",
"WEBEX_CALLING_DYNAMIC_DEVICE_CONFIGURATION",
"NONE"
],
"description": " * `WEBEX_CALLING_DEVICE_CONFIGURATION` - Devices which supports Webex Calling Device Settings Configuration.\n * `WEBEX_DEVICE_CONFIGURATION` - Devices which supports Webex Device Settings Configuration.\n * `WEBEX_CALLING_DYNAMIC_DEVICE_CONFIGURATION` - Devices which supports Webex Calling dynamic Settings Configuration.\n * `NONE` - Devices does not support any configuration.\n"
},
"KemModuleType": {
"type": "string",
"enum": [
"KEM_14_KEYS",
"KEM_18_KEYS",
"KEM_20_KEYS"
],
"description": " * `KEM_14_KEYS` - Extension module has 14 line keys that can be configured.\n * `KEM_18_KEYS` - Extension module has 18 line keys that can be configured.\n * `KEM_20_KEYS` - Extension module has 20 line keys that can be configured.\n"
},
"ActivationCode": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "5414011256173816",
"description": "The activation code."
},
"expiryTime": {
"type": "string",
"example": "2017-11-16T23:38:03.215Z",
"description": "The date and time the activation code expires."
}
}
},
"Device": {
"type": "object",
"required": [
"created"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3",
"description": "A unique identifier for the device."
},
"displayName": {
"type": "string",
"example": "SFO12-3-PanHandle",
"description": "A friendly name for the device."
},
"placeId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
"description": "The `placeId` field has been deprecated. Please use `workspaceId` instead."
},
"workspaceId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
"description": "The workspace associated with the device."
},
"personId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
"description": "The person associated with the device."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The organization associated with the device."
},
"capabilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceCapabilities"
},
"description": "The capabilities of the device.",
"example": [
"xapi"
]
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DevicePermissions"
},
"description": "The permissions the user has for this device. For example, `xapi` means this user is entitled to using the `xapi` against this device.",
"example": [
"xapi:readonly",
"xapi:all"
]
},
"connectionStatus": {
"$ref": "#/components/schemas/DeviceConnectionStatus"
},
"product": {
"type": "string",
"example": "Cisco Webex DX80",
"description": "The product name. A display friendly version of the device's `model`."
},
"type": {
"type": "string",
"example": "roomdesk",
"description": "The product type."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"example": "First Tag, Second Tag"
},
"description": "Tags assigned to the device.",
"example": [
"First Tag",
"Second Tag"
]
},
"ip": {
"type": "string",
"example": "100.110.120.130",
"description": "The current IP address of the device."
},
"activeInterface": {
"$ref": "#/components/schemas/NetworkConnectivityType"
},
"mac": {
"type": "string",
"example": "11:22:33:44:AA:FF",
"description": "The unique address for the network adapter."
},
"primarySipUrl": {
"type": "string",
"example": "sample_device@sample_workspacename.orgname.org",
"description": "The primary SIP address to dial this device."
},
"sipUrls": {
"example": [
"sample_device@sample_workspacename.orgname.org",
"another_device@sample_workspacename.orgname.org"
],
"type": "array",
"items": {
"type": "string",
"example": "sample_device@sample_workspacename.orgname.org, another_device@sample_workspacename.orgname.org"
},
"description": "All SIP addresses to dial this device."
},
"serial": {
"type": "string",
"example": "FOC1923NVVN",
"description": "Serial number for the device."
},
"software": {
"type": "string",
"example": "RoomOS 2018-06-01 608dcdbb6e1",
"description": "The operating system name data and version tag."
},
"upgradeChannel": {
"type": "string",
"example": "beta",
"description": "The upgrade channel the device is assigned to."
},
"created": {
"type": "string",
"example": "2016-04-21T17:00:00.000Z",
"description": "The date and time that the device was registered, in ISO8601 format."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The location associated with the device."
},
"workspaceLocationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The workspace location associated with the device. Deprecated, prefer `locationId`."
},
"errorCodes": {
"example": [
"sipprofileregistration"
],
"type": "array",
"items": {
"type": "string",
"example": "sipprofileregistration"
},
"description": "Error codes coming from the device."
},
"firstSeen": {
"type": "string",
"example": "2021-02-24T09:08:38.822Z",
"description": "Timestamp of the first time device sent a status post."
},
"lastSeen": {
"type": "string",
"example": "2023-08-15T14:04:00.444Z",
"description": "Timestamp of the last time device sent a status post."
},
"managedBy": {
"$ref": "#/components/schemas/ManagedBy"
},
"devicePlatform": {
"$ref": "#/components/schemas/DevicePlatform"
},
"plannedMaintenance": {
"type": "object",
"description": "The planned maintenance for the device.",
"properties": {
"mode": {
"type": "string",
"enum": [
"off",
"on",
"upcoming"
],
"description": "The planned maintenance mode for the device"
}
}
}
}
},
"DeviceCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Device"
}
}
}
},
"NetworkConnectivityType": {
"type": "string",
"enum": [
"wired"
],
"description": "The current network connectivity for the device.",
"example": "wired"
},
"DeviceConnectionStatus": {
"type": "string",
"enum": [
"connected",
"disconnected",
"connected_with_issues",
"offline_expired",
"activating",
"unknown",
"offline_deep_sleep"
],
"description": "The connection status of the device.",
"example": "connected"
},
"DevicePermissions": {
"type": "string",
"enum": [
"xapi:readonly",
"xapi:all"
]
},
"DeviceCapabilities": {
"type": "string",
"enum": [
"xapi"
]
},
"ManagedBy": {
"type": "string",
"enum": [
"CISCO",
"CUSTOMER",
"PARTNER"
],
"description": "Entity managing the device configuration.",
"example": "CISCO"
},
"DevicePlatform": {
"type": "string",
"enum": [
"cisco",
"microsoftTeamsRoom"
],
"description": "Device platform",
"example": "cisco"
},
"MaintenanceMode": {
"type": "string",
"enum": [
"off",
"on",
"upcoming"
],
"example": "off",
"description": "The maintenance mode of the device."
},
"Event": {
"type": "object",
"required": [
"id",
"resource",
"type",
"actorId",
"orgId",
"created",
"data"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0VWRU5UL2JiY2ViMWFkLTQzZjEtM2I1OC05MTQ3LWYxNGJiMGM0ZDE1NAo",
"description": "The unique identifier for the event."
},
"resource": {
"$ref": "#/components/schemas/EventResourceEnum",
"description": "The type of resource in the event."
},
"type": {
"$ref": "#/components/schemas/EventTypeEnum",
"description": "The action which took place in the event."
},
"appId": {
"type": "string",
"example": "null",
"description": "The ID of the application for the event."
},
"actorId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"description": "The ID of the person who performed the action."
},
"orgId": {
"type": "string",
"example": "OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"description": "The ID of the organization for the event."
},
"created": {
"type": "string",
"example": "2016-05-16T21:34:59.324Z",
"description": "The date and time of the event."
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL01FU1NBR0UvOTJkYjNiZTAtNDNiZC0xMWU2LThhZTktZGQ1YjNkZmM1NjVk"
},
"roomId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0"
},
"roomType": {
"type": "string",
"example": "group"
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jZTg2MWZiYS02ZTJmLTQ5ZjktOWE4NC1iMzU0MDA4ZmFjOWU"
},
"text": {
"type": "string",
"example": "PROJECT UPDATE - A new project plan has been published on Box: http://box.com/s/lf5vj. The PM for this project is Mike C. and the Engineering Manager is Jane W."
},
"personId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY"
},
"personEmail": {
"type": "string",
"example": "matt@example.com"
},
"meetingId": {
"type": "string",
"example": "16ce696f75844d24b2d4fab04b4419af_I_183979003076423608"
},
"creatorId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS82YWE2ZGE5OS0xYzdlLTQ4MWItODY3YS03MWY2NTIwNDk0MzM"
},
"host": {
"type": "object",
"properties": {},
"description": "The meeting's host data."
},
"attendees": {
"type": "array",
"items": {},
"description": "Common Identity (CI) authenticated meeting attendees."
},
"transcriptionEnabled": {
"type": "string",
"example": "yes",
"description": "Indicates whether or not the Voice Assistant was enabled during the meeting. If `true` a transcript should be available a couple minutes after the meeting ended at the [meetingTranscripts resource](/docs/api/v1/meeting-transcripts)."
},
"recordingEnabled": {
"type": "string",
"example": "yes",
"description": "Indicates if recording was enabled for all or parts of the meeting. If `true` a recording should be available shortly after the meeting ended at the [recordings resource](/docs/api/v1/recordings)."
},
"hasPostMeetingsChat": {
"type": "string",
"example": "yes",
"description": "Indicates if chat messages were exchanged during the meeting in the meetings client (not the unified client). If `true` these messages can be accessed by a compliance officer at the [postMeetingsChat](/docs/api/v1/meetings-chat) resource. Meetings chat collection must be custom enabled."
},
"corelationId": {
"type": "string",
"example": "fdda8613-d34b-424c-8c6a-44ff2e19379c",
"description": "Telephony; The corelation id."
},
"callType": {
"type": "string",
"example": "SIP_ENTERPRISE",
"description": "Telephony; call types (examples `VIDEO_DIALIN`,`VIDEO_DIALOUT`,`CASCADE`,`HYBRID_CASCADE`,`PSTN_SIP`,`PSTN_DIALIN`,`PSTN_DIALOUT`,`PSTN_ONLY_DIALIN`,`PSTN_ONLY_DIALOUT`,`H323`,`H323_IP`,`SIP_ENTERPRISE`,`SIP_MOBILE`,`SIP_NATIONAL`,`SIP_INTERNATIONAL`,`SIP_EMERGENCY`,`SIP_OPERATOR`,`SIP_SHORTCODE`,`SIP_TOLLFREE`,`SIP_PREMIUM`,`SIP_URI`,`SIP_INBOUND`,`UNKNOWN`,`ZTM`,`SIP_MEETING`)."
},
"userId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZjEwMTU1NC04ZGJjLTQyMmUtOGEzZC1kYTk1YTI3NWZlNzU",
"description": "Telephony; user id of the CDR owner."
},
"userType": {
"type": "string",
"example": "User",
"description": "Telephony; The type of user (`User`,`Anchor`,`AutomatedAttendantBasic`,`AutomatedAttendantStandard`,`AutomatedAttendantVideo`,`BroadworksAnywhere`,`CallCenterBasic`,`CallCenterPremium`,`CallCenterStandard`,`CollaborateBridge`,`ContactCenterAdaptor`,`FindMeFollowMe`,`FlexibleSeatingHost`,`GroupCall`,`GroupPaging`,`HuntGroup`,`LocalGateway`,`MeetMeConference`,`Place`,`RoutePoint`,`SystemVoicePortal`,`VoiceMailGroup`,`VoiceMailRetrieval`,`VoiceXML`,`VirtualLine`,`Unknown`)."
},
"callDirection": {
"type": "string",
"example": "ORIGINTATING",
"description": "Telephony; `ORIGINATING` or `TERMINATING`."
},
"isCallAnswered": {
"type": "string",
"example": "true",
"description": "Telephony; indicates if the call was answered."
},
"callDurationSeconds": {
"type": "string",
"example": "192",
"description": "Telephony; duration of call in seconds."
},
"callStartTime": {
"type": "string",
"example": "2023-02-08T06:12:43.976Z",
"description": "Telephony; ISO 8601."
},
"callAnswerTime": {
"type": "string",
"example": "2023-02-08T06:12:47.012Z",
"description": "Telephony; ISO 8601."
},
"callTransferTime": {
"type": "string",
"example": "2023-02-08T06:15:19.112Z",
"description": "Telephony; ISO 8601."
},
"callingNumber": {
"type": "string",
"example": "910481234",
"description": "Telephony; originating number."
},
"callingLineId": {
"type": "string",
"example": "211",
"description": "Telephony."
},
"calledNumber": {
"type": "string",
"example": "4089671221",
"description": "Telephony; destination number."
},
"calledLineId": {
"type": "string",
"example": "219",
"description": "Telephony"
},
"dialedDigits": {
"type": "string",
"example": "123",
"description": "Telephony"
},
"callRedirectingNumber": {
"type": "string",
"description": "Telephony"
},
"callRedirectedReason": {
"type": "string",
"description": "Telephony"
},
"created": {
"type": "string",
"example": "2016-05-16T21:34:59.324Z"
},
"type": {
"type": "string",
"example": "direct",
"description": "Message type `direct` or `group` message."
},
"breakoutSessionId": {
"type": "string",
"example": "d66a4a90-4f50-11ef-bc94-f5c71646dc71",
"description": "The breakout session Id in cases where the action happened in a meeting's brakout session, for example a `meetingMessage`."
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Recipient"
},
"description": "The recipients list for directed meetingMessages."
}
},
"description": "The event's data representation. This object will contain the event's `resource`, such as [memberships](/docs/api/v1/memberships/get-membership-details), [messages](/docs/api/v1/messages/get-message-details), [meetings](/docs/api/v1/meetings), [meetingMessages](/docs/api/v1/meetingMessages), [tabs](/docs/api/v1/room-tabs), [rooms](/docs/api/v1/space-classifications) or [attachmentActions](/docs/api/v1/attachment-actions) at the time the event took place."
}
}
},
"EventCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Event"
}
}
}
},
"EventResourceEnum": {
"type": "string",
"enum": [
"attachmentActions",
"businessTexts",
"call_records",
"convergedRecordings",
"file_transcodings",
"files",
"meetingMessages",
"meetings",
"meetingTranscripts",
"memberships",
"messages",
"rooms",
"tabs"
],
"description": " * `attachmentActions` - State changed on a card attachment\n * `businessTexts` - A user sent or received a SMS message\n * `call_records` - A Webex call was made to/from a user\n * `convergedRecordings` - A Webex call was recorded for a user\n * `file_transcodings` - State change on a file preview\n * `files` - State changed on a file download\n * `meetingMessages` - State changed on a meeting message, i.e. message exchanged as part of a meeting\n * `meetings` - State change on a meeting ( here combined with type = 'ended' )\n * `meetingTranscripts` - State change on a automatic transcript resource for Webex Assistant\n * `memberships` - State changed on a memberships resource\n * `messages` - State changed on a messages resource\n * `rooms` - State changed on a space classification\n * `tabs` - State changed on a room tabs in a space\n"
},
"EventTypeEnum": {
"type": "string",
"enum": [
"created",
"updated",
"deleted",
"ended"
],
"description": " * `created` - The resource has been created\n * `updated` - A property on the resource has been updated\n * `deleted` - The resource has been deleted\n * `ended` - The meeting has ended\n"
},
"Recipient": {
"type": "object",
"properties": {
"personId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9lOGYwOTIwOC00ZjUxLTExZWYtOTQ4My1iYTA3NjE2MzY4NmQ",
"description": "The personId of the recipient"
},
"personEmail": {
"type": "string",
"example": "johndoe@simplistic.com",
"description": "The personEmail"
},
"guestDisplayName": {
"type": "string",
"example": "John Wayne",
"description": "Guests, who are unauthenticated users, have a guestDisplayName"
},
"guestEmail": {
"type": "string",
"example": "jwayne@mailinator.com",
"description": "Guests, who are unauthenticated users, have a guestEmail"
}
}
},
"HotDeskSessionsResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HotDesk"
}
}
}
},
"HotDesk": {
"type": "object",
"properties": {
"sessionId": {
"type": "string",
"example": "Y2lzY29...",
"description": "A unique identifier for a hot desk session."
},
"workspaceId": {
"type": "string",
"example": "YL34EmB...",
"description": "The workspace where the hot desk session is active."
},
"personId": {
"type": "string",
"example": "YL34EmA...",
"description": "The id of the person who initiated the hot desk session."
},
"bookingStartTime": {
"type": "string",
"example": "2024-08-29T12:00:00Z",
"description": "The start time of the booking."
},
"bookingEndTime": {
"type": "string",
"example": "2024-08-29T20:00:00Z",
"description": "The end time of the booking."
}
}
},
"Location": {
"type": "object",
"required": [
"address",
"countryCode",
"latitude",
"longitude"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"description": "Unique identifier for the location."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzA2OWEzMDY2LTgwNjMtNDI0Zi05YmE0LTBhZDdhMmYxMzNjNQ",
"description": "The ID to use for this location in the [/locations API](/docs/api/v1/locations)"
},
"displayName": {
"type": "string",
"example": "Cisco Barcelona",
"description": "A friendly name for the location."
},
"address": {
"type": "string",
"example": "Carrer de Pere IV, Barcelona, Spain",
"description": "The location address."
},
"countryCode": {
"type": "string",
"example": "ES",
"description": "The location country code (ISO 3166-1)."
},
"cityName": {
"type": "string",
"example": "Barcelona",
"description": "The location city name."
},
"latitude": {
"type": "number",
"example": 41.406615,
"description": "The location latitude."
},
"longitude": {
"type": "number",
"example": 2.200717,
"description": "The location longitude."
},
"notes": {
"type": "string",
"example": "A note about the location",
"description": "Notes associated with the location."
}
}
},
"PutCommonLocationObject": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Denver",
"description": "The name of the location. Supports up to 256 characters, but locations enabled for Webex Calling are limited to 80 characters maximum."
},
"timeZone": {
"type": "string",
"example": "America/Chicago",
"description": "Time zone associated with this location, refer to this link (https://developer.webex.com/docs/api/guides/webex-for-broadworks-developers-guide#webex-meetings-site-timezone) for format."
},
"preferredLanguage": {
"type": "string",
"example": "en_us",
"description": "Default email language."
},
"address": {
"type": "object",
"properties": {
"address1": {
"type": "string",
"example": "123 Some St.",
"description": "Address 1"
},
"address2": {
"type": "string",
"example": "Suite 456",
"description": "Address 2"
},
"city": {
"type": "string",
"example": "Supercity",
"description": "City"
},
"state": {
"type": "string",
"example": "Goodstate",
"description": "State code"
},
"postalCode": {
"type": "string",
"example": "12345",
"description": "Postal Code"
},
"country": {
"type": "string",
"example": "US",
"description": "ISO-3166 2-Letter Country Code."
}
},
"description": "The address of the location."
}
}
},
"PostCommonLocationObject": {
"type": "object",
"required": [
"name",
"timeZone",
"preferredLanguage",
"announcementLanguage",
"address"
],
"properties": {
"name": {
"type": "string",
"example": "Denver",
"description": "The name of the location. Supports up to 256 characters, but locations enabled for Webex Calling are limited to 80 characters maximum."
},
"timeZone": {
"type": "string",
"example": "America/Chicago",
"description": "Time zone associated with this location, refer to this link (https://developer.webex.com/docs/api/guides/webex-for-broadworks-developers-guide#webex-meetings-site-timezone) for format."
},
"preferredLanguage": {
"type": "string",
"example": "en_us",
"description": "Default email language."
},
"announcementLanguage": {
"type": "string",
"example": "fr_fr",
"description": "Location's phone announcement language."
},
"address": {
"type": "object",
"required": [
"address1",
"city",
"state",
"postalCode",
"country"
],
"properties": {
"address1": {
"type": "string",
"example": "123 Some St.",
"description": "Address 1"
},
"address2": {
"type": "string",
"example": "Suite 456",
"description": "Address 2"
},
"city": {
"type": "string",
"example": "Supercity",
"description": "City"
},
"state": {
"type": "string",
"example": "Goodstate",
"description": "State code"
},
"postalCode": {
"type": "string",
"example": "12345",
"description": "Postal Code"
},
"country": {
"type": "string",
"example": "US",
"description": "ISO-3166 2-Letter Country Code."
}
},
"description": "The address of the location."
},
"latitude": {
"type": "string",
"example": "12.935784",
"description": "Latitude"
},
"longitude": {
"type": "string",
"example": "77.697332",
"description": "Longitude"
},
"notes": {
"type": "string",
"example": "123 Some St. Denver Location",
"description": "Notes"
}
}
},
"LocationsCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location"
}
}
}
},
"Floor": {
"type": "object",
"required": [
"floorNumber"
],
"properties": {
"id": {
"type": "string",
"example": "xxx==",
"description": "Unique identifier for the floor."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"description": "Unique identifier for the location."
},
"floorNumber": {
"type": "number",
"example": -1,
"description": "The floor number."
},
"displayName": {
"type": "string",
"example": "The basement",
"description": "The floor display name."
}
}
},
"FloorUpdated": {
"type": "object",
"required": [
"floorNumber"
],
"properties": {
"id": {
"type": "string",
"example": "xxx==",
"description": "Unique identifier for the floor."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"description": "Unique identifier for the location."
},
"floorNumber": {
"type": "number",
"example": 1,
"description": "The floor number."
},
"displayName": {
"type": "string",
"example": "My custom name",
"description": "The floor display name."
}
}
},
"FloorCreationRequest": {
"type": "object",
"required": [
"floorNumber"
],
"properties": {
"floorNumber": {
"type": "number",
"example": -1,
"description": "The floor number."
},
"displayName": {
"type": "string",
"example": "The basement",
"description": "The floor display name."
}
}
},
"FloorUpdateRequest": {
"type": "object",
"required": [
"floorNumber"
],
"properties": {
"floorNumber": {
"type": "number",
"example": 1,
"description": "The floor number."
},
"displayName": {
"type": "string",
"example": "My custom name",
"description": "The floor display name."
}
}
},
"FloorCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Floor"
},
"description": "An array of floor objects."
}
}
},
"MeetingQualitiesResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaSessionQuality"
}
}
}
},
"MediaSessionQuality": {
"type": "object",
"required": [
"meetingInstanceId"
],
"properties": {
"meetingInstanceId": {
"type": "string",
"example": "e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470",
"description": "The meeting identifier for the specific meeting instance."
},
"webexUserName": {
"type": "string",
"example": "John Andersen",
"description": "The display name of the participant of this media session."
},
"webexUserEmail": {
"type": "string",
"example": "john.andersen@example.com",
"description": "The email address of the participant of this media session."
},
"joinTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this participant joined the meeting."
},
"leaveTime": {
"type": "string",
"example": "2020-04-10T17:02:00.000Z",
"description": "The date and time when this participant left the meeting."
},
"joinMeetingTime": {
"type": "string",
"example": "5.793",
"description": "The join meeting time of the participant. "
},
"clientType": {
"type": "string",
"example": "Teams_Mobile_Client (iOS)",
"description": "The type of the client (and OS) used by this media session."
},
"clientVersion": {
"type": "string",
"example": "40.5.0.210",
"description": "The version of the client used by this media session."
},
"osType": {
"type": "string",
"example": "mac",
"description": "The operating system used for the client."
},
"osVersion": {
"type": "string",
"example": "Version 10.14.6 (Build 18G3020)",
"description": "The version of the operating system used for the client."
},
"hardwareType": {
"type": "string",
"example": "mac book",
"description": "The type of hardware used to attend the meeting"
},
"speakerName": {
"type": "string",
"example": "MacBook Pro Speakers",
"description": "A description of the speaker used in the meeting."
},
"networkType": {
"type": "string",
"enum": [
"wifi",
"cellular",
"ethernet",
"unknown"
],
"description": "The type of network."
},
"localIP": {
"type": "string",
"example": "10.24.72.54",
"description": "The local IP address of the client."
},
"publicIP": {
"type": "string",
"example": "10.24.72.54",
"description": "The public IP address of the client."
},
"maskedLocalIP": {
"type": "string",
"example": "10.24.72.54",
"description": "The masked local IP address of the client."
},
"maskedPublicIP": {
"type": "string",
"example": "10.24.72.54",
"description": "The masked public IP address of the client."
},
"camera": {
"type": "string",
"example": "FaceTime HD Camera",
"description": "A description of the camera used in the meeting."
},
"microphone": {
"type": "string",
"example": "External Microphone",
"description": "A description of the microphone used in the meeting."
},
"serverRegion": {
"type": "string",
"example": "San Jose, USA",
"description": "The server region."
},
"videoMeshCluster": {
"type": "string",
"example": "Mesh Cluster One",
"description": "The video mesh cluster name."
},
"videoMeshServer": {
"type": "string",
"example": "server.example.com",
"description": "The video mesh server name."
},
"participantId": {
"type": "string",
"example": "8635cbf0ca1a4573b27348e560679b25_I_158174534545967299_57",
"description": "Identifies the participant."
},
"participantSessionId": {
"type": "string",
"example": "3324C9D0-9EA7-45A2-B249-5B62A384AFEF",
"description": "Identifies a specific session the participant has in a given meeting."
},
"videoIn": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VideoIn"
},
"description": "The collection of downstream (sent to the client) video quality data."
},
"videoOut": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VideoOut"
},
"description": "The collection of upstream (sent from the client) video quality data."
},
"audioIn": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudioIn"
},
"description": "The collection of downstream (sent to the client) audio quality data."
},
"audioOut": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudioOut"
},
"description": "The collection of upstream (sent from the client) audio quality data."
},
"shareIn": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareIn"
},
"description": "The collection of downstream (sent to the client) share quality data."
},
"shareOut": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareOut"
},
"description": "The collection of upstream (sent from the client) share quality data."
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resources"
},
"description": "Device resources such as CPU and memory."
}
}
},
"VideoIn": {
"type": "object",
"properties": {
"samplingInterval": {
"type": "number",
"example": 60,
"description": "The sampling interval, in seconds, of the downstream video quality data."
},
"startTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this video session started."
},
"endTime": {
"type": "string",
"example": "2020-04-10T18:00:00.000Z",
"description": "The date and time when this video session ended."
},
"packetLoss": {
"type": "array",
"items": {
"type": "number"
},
"description": "The percentage of video packet loss, as a float between 0.0 and 100.0, during each sampling interval."
},
"latency": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average latency, in milliseconds, during each sampling interval."
},
"resolutionHeight": {
"type": "array",
"items": {
"type": "number"
},
"description": "The pixel height of the incoming video."
},
"frameRate": {
"type": "array",
"items": {
"type": "number",
"example": 25.940001
},
"description": "The frames per second of the incoming video."
},
"mediaBitRate": {
"type": "array",
"items": {
"type": "number"
},
"description": "The bit rate of the incoming video."
},
"codec": {
"type": "string",
"example": "H.264 BP",
"description": "The incoming video codec."
},
"jitter": {
"type": "array",
"items": {
"type": "number",
"example": 170
},
"description": "The incoming video jitter."
},
"transportType": {
"type": "string",
"enum": [
"UDP",
"TCP"
],
"description": "The network protocol used for video transmission."
}
}
},
"VideoOut": {
"type": "object",
"properties": {
"samplingInterval": {
"type": "number",
"example": 60,
"description": "The sampling interval, in seconds, of the upstream video quality data."
},
"startTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this video session started."
},
"endTime": {
"type": "string",
"example": "2020-04-10T18:00:00.000Z",
"description": "The date and time when this video session ended."
},
"packetLoss": {
"type": "array",
"items": {
"type": "number"
},
"description": "The percentage of video packet loss, in float between 0.0 and 100.0, during each sampling interval."
},
"latency": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average latency, in milliseconds, during each sampling interval."
},
"resolutionHeight": {
"type": "array",
"items": {
"type": "number"
},
"description": "The pixel height of the outgoing video."
},
"frameRate": {
"type": "array",
"items": {
"type": "number",
"example": 25.940001
},
"description": "The frames per second of the outgoing video."
},
"mediaBitRate": {
"type": "array",
"items": {
"type": "number"
},
"description": "The bit rate of the outgoing video."
},
"codec": {
"type": "string",
"example": "H.264 BP",
"description": "The outgoing video codec."
},
"jitter": {
"type": "array",
"items": {
"type": "number"
},
"description": "The outgoing video jitter."
},
"transportType": {
"type": "string",
"enum": [
"UDP",
"TCP"
],
"description": "The network protocol used for video transmission."
}
}
},
"AudioIn": {
"type": "object",
"properties": {
"samplingInterval": {
"type": "number",
"example": 60,
"description": "The sampling interval, in seconds, of the downstream audio quality data."
},
"startTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this audio session started."
},
"endTime": {
"type": "string",
"example": "2020-04-10T18:00:00.000Z",
"description": "The date and time when this audio session ended."
},
"packetLoss": {
"type": "array",
"items": {
"type": "number"
},
"description": "The percentage of audio packet loss, as a float between 0.0 and 100.0, during each sampling interval."
},
"latency": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average latency, in milliseconds, during each sampling interval."
},
"resolutionHeight": {
"type": "array",
"items": {
"type": "number"
},
"description": "Not applicable to audio."
},
"frameRate": {
"type": "array",
"items": {
"type": "number",
"example": 25.940001
},
"description": "Not applicable to audio."
},
"mediaBitRate": {
"type": "array",
"items": {
"type": "number"
},
"description": "The bitrate of the incoming audio."
},
"codec": {
"type": "string",
"example": "Opus",
"description": "The codec of the incoming audio."
},
"jitter": {
"type": "array",
"items": {
"type": "number"
},
"description": "The incoming audio jitter."
},
"transportType": {
"type": "string",
"enum": [
"UDP",
"TCP"
],
"description": "The network protocol used for video transmission."
}
}
},
"AudioOut": {
"type": "object",
"properties": {
"samplingInterval": {
"type": "number",
"example": 60,
"description": "The sampling interval, in seconds, of the upstream audio quality data."
},
"startTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this audio session started."
},
"endTime": {
"type": "string",
"example": "2020-04-10T18:00:00.000Z",
"description": "The date and time when this audio session ended."
},
"packetLoss": {
"type": "array",
"items": {
"type": "number"
},
"description": "The percentage of audio packet loss, as a float between 0.0 and 100.0, during each sampling interval."
},
"latency": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average latency, in milliseconds, during each sampling interval."
},
"resolutionHeight": {
"type": "array",
"items": {
"type": "number"
},
"description": "Not applicable to audio out."
},
"frameRate": {
"type": "array",
"items": {
"type": "number",
"example": 25.940001
},
"description": "Not applicable to audio out."
},
"mediaBitRate": {
"type": "array",
"items": {
"type": "number"
},
"description": "The bit rate of the outgoing audio."
},
"codec": {
"type": "string",
"example": "Opus",
"description": "The audio codec."
},
"jitter": {
"type": "array",
"items": {
"type": "number"
},
"description": "The outgoing audio jitter."
},
"transportType": {
"type": "string",
"enum": [
"UDP",
"TCP"
],
"description": "The network protocol used for video transmission."
}
}
},
"ShareIn": {
"type": "object",
"properties": {
"samplingInterval": {
"type": "number",
"example": 60,
"description": "The sampling interval, in seconds, of the downstream content sharing data."
},
"startTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this content sharing session started."
},
"endTime": {
"type": "string",
"example": "2020-04-10T18:00:00.000Z",
"description": "The date and time when this content sharing session ended."
},
"packetLoss": {
"type": "array",
"items": {
"type": "number"
},
"description": "The percentage of content sharing packet loss, as a float between 0.0 and 100.0, during each sampling interval."
},
"latency": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average latency, in milliseconds, during each sampling interval."
},
"resolutionHeight": {
"type": "array",
"items": {
"type": "number"
},
"description": "The height in pixels of the incoming share video."
},
"frameRate": {
"type": "array",
"items": {
"type": "number",
"example": 25.940001
},
"description": "The frame rate of the incoming share video."
},
"mediaBitRate": {
"type": "array",
"items": {
"type": "number"
},
"description": "The bit rate for the incoming share video."
},
"codec": {
"type": "string",
"example": "H.264 BP",
"description": "The codec for the incoming share video."
},
"jitter": {
"type": "array",
"items": {
"type": "number"
},
"description": "The jitter for the incoming share video."
},
"transportType": {
"type": "string",
"enum": [
"UDP",
"TCP"
],
"description": "The network protocol used for video transmission."
}
}
},
"ShareOut": {
"type": "object",
"properties": {
"samplingInterval": {
"type": "number",
"example": 60,
"description": "The sampling interval, in seconds, of the upstream content sharing data."
},
"startTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this content sharing session started."
},
"endTime": {
"type": "string",
"example": "2020-04-10T18:00:00.000Z",
"description": "The date and time when this content sharing session ended."
},
"packetLoss": {
"type": "array",
"items": {
"type": "number"
},
"description": "The percentage of content sharing packet loss, in float between 0.0 and 100.0, during each sampling interval."
},
"latency": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average latency, in milliseconds, during each sampling interval."
},
"resolutionHeight": {
"type": "array",
"items": {
"type": "number"
},
"description": "The height in pixels of the outgoing share video."
},
"frameRate": {
"type": "array",
"items": {
"type": "number",
"example": 25.940001
},
"description": "The frame rate of the outgoing share video."
},
"mediaBitRate": {
"type": "array",
"items": {
"type": "number"
},
"description": "The bit rate of the outgoing share video."
},
"codec": {
"type": "string",
"example": "H.264 BP",
"description": "The codec of the outgoing share video."
},
"jitter": {
"type": "array",
"items": {
"type": "number"
},
"description": "The jitter for the outgoing share video."
},
"transportType": {
"type": "string",
"enum": [
"UDP",
"TCP"
],
"description": "The network protocol used for video transmission."
}
}
},
"Resources": {
"type": "object",
"properties": {
"processAverageCPU": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average percent CPU for the process."
},
"processMaxCPU": {
"type": "array",
"items": {
"type": "number"
},
"description": "The max percent CPU for the process."
},
"systemAverageCPU": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average percent CPU for the system."
},
"systemMaxCPU": {
"type": "array",
"items": {
"type": "number"
},
"description": "The max percent CPU for the system."
}
}
},
"Report": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "'Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2ZhOA'",
"description": "A unique report ID that corresponds to a billing report."
},
"billingStartDate": {
"type": "string",
"example": "2021-05-21",
"description": "Billing report `startDate`."
},
"billingEndDate": {
"type": "string",
"example": "2021-05-30",
"description": "Billing report `endDate`."
},
"type": {
"type": "string",
"enum": [
"USER",
"CUSTOMER",
"PARTNER"
],
"description": "Billing Report Type"
},
"category": {
"type": "string",
"example": "RECONCILIATION",
"enum": [
"RECONCILIATION",
"POINT_IN_TIME"
],
"description": "The category of the billing report."
},
"created": {
"type": "string",
"example": "2021-06-16T12:40:33.109Z",
"description": "The date and time the report was generated."
},
"createdBy": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wYWNkMzg3NS00ZTEyLTRkNzctYjk4MS1lMzg5ZmQ4ODQ2YzA",
"description": "The person ID of the partner administrator who created the report."
},
"status": {
"type": "string",
"enum": [
"IN_PROGRESS",
"COMPLETED",
"FAILED"
],
"description": "The status of the billing report.\n * `IN_PROGRESS` - Report generation is in progress\n * `COMPLETED` - Report generation is complete\n * `FAILED` - Report generation failed\n"
},
"tempDownloadURL": {
"type": "string",
"example": "https://billing-reports-int-us-east-1.webexcontent.com/a366de9b-3204-4140-8181-25808d360e36/WHOLESALE/340177d1-7f25-41e1-a39f-ad63ec1103a5.csv?Expires=1624978489&Signature=Syp3vrVeMx4P6MeMtm8e1bQaeAdHFe-c7NeHERWh5-qJGLZ1T8Dvl2ee-M8OsFf~z6Yepz94e2Hh1HDVailD0Uryl8SgiM~jl0cBh7L0PmSe~i9oFA0eJ0MulkqGSMVf7ZHhxY55xYMgIBZIERkWm3CqQNDg5BS4EaXapKfOnmFegf36OokCM63m5uOK8-csk08IkZhwo2Z0l1JMtuWYEaLh4dgMHoe~xgH3YmDSSCWInFYaEifUAfgi2YAYS6nP9Zq4BTliBq62XBaehOE1gBrhy4RdwD-3WSs2oD-BdpoRpuGzo3FZzDLVEvd0S2D6gTcHljOHodQKxe-u0BXPWQ__&Key-Pair-Id=APKAJADAKLCI2FW2U32Q",
"description": "The URL for partners to download the billing report."
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReportError"
},
"description": "List of errors that occurred during report generation.\n\n**Note:**\n\n* This list captures errors that occurred during asynchronous or background report generation, after the request has been accepted and a `202 OK` response is returned."
}
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2ZhOA",
"billingStartDate": "2021-05-21",
"billingEndDate": "2021-05-30",
"reportType": "PARTNER",
"category": "RECONCILIATION",
"createdBy": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wYWNkMzg3NS00ZTEyLTRkNzctYjk4MS1lMzg5ZmQ4ODQ2YzA",
"status": "COMPLETED",
"tempDownloadURL": "https://billing-reports-int-us-east-1.webexcontent.com/sample.csv",
"errors": []
}
},
"ReportCollectionResponse": {
"type": "object",
"properties": {
"Report Attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Report"
},
"description": "An array of report objects."
}
}
},
"Template": {
"type": "object",
"properties": {
"templateId": {
"type": "string",
"example": "130",
"description": "Unique identifier representing a report."
},
"title": {
"type": "string",
"example": "Calling Usage",
"description": "Name of the template."
},
"service": {
"type": "string",
"example": "Teams",
"description": "The service to which the report belongs."
},
"category": {
"type": "string",
"example": "Partner",
"description": "Generated reports belong to which category."
},
"maxDays": {
"type": "number",
"example": 31,
"description": "Maximum date range for reports belonging to this template."
},
"dataStartDate": {
"type": "string",
"example": "2024-01-01",
"description": "Start date of the data in the reports belonging to this template."
},
"dataEndDate": {
"type": "string",
"example": "2024-01-31",
"description": "End date of the data in the reports belonging to this template."
}
}
},
"TemplateCollectionResponse": {
"type": "object",
"properties": {
"Template Collection": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Template"
},
"description": "An array of template objects."
}
}
},
"Person": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"description": "A unique identifier for the person."
},
"emails": {
"type": "array",
"items": {
"type": "string",
"example": "john.andersen@example.com"
},
"description": "The email addresses of the person."
},
"phoneNumbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"work",
"work_extension",
"mobile",
"fax"
],
"description": "The type of phone number.\n * `work` - Work phone number of the person.\n * `work_extension` - Work extension of the person. For the Webex Calling person, the value will have a routing prefix along with the extension.\n * `mobile` - Mobile number of the person.\n * `fax` - FAX number of the person.\n"
},
"value": {
"type": "string",
"example": "+1 408 526 7209",
"description": "The phone number."
},
"primary": {
"type": "boolean",
"example": true,
"description": "Primary number for the person."
}
}
},
"description": "Phone numbers for the person."
},
"extension": {
"type": "string",
"example": "133",
"description": "The Webex Calling extension for the person. Only applies to a person with a Webex Calling license."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
"description": "The ID of the location for this person retrieved from BroadCloud."
},
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "The full name of the person."
},
"nickName": {
"type": "string",
"example": "John",
"description": "The nickname of the person if configured. If no nickname is configured for the person, this field will not be present."
},
"firstName": {
"type": "string",
"example": "John",
"description": "The first name of the person."
},
"lastName": {
"type": "string",
"example": "Andersen",
"description": "The last name of the person."
},
"avatar": {
"type": "string",
"example": "https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600",
"description": "The URL to the person's avatar in PNG format."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The ID of the organization to which this person belongs."
},
"roles": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
},
"description": "An array of role strings representing the roles to which this admin user belongs."
},
"licenses": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
},
"description": "An array of license strings allocated to this person."
},
"department": {
"type": "string",
"example": "Sales",
"description": "The business department the user belongs to."
},
"manager": {
"type": "string",
"example": "John Duarte",
"description": "A manager identifier."
},
"managerId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80ZGEzYTI0OC05YjBhLTQxMDgtODU0NC1iNTQwMzEyZTU2M2E",
"description": "Person ID of the manager."
},
"title": {
"type": "string",
"example": "GM",
"description": "The person's title."
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "work",
"description": "The type of address."
},
"country": {
"type": "string",
"example": "US",
"description": "The user's country."
},
"locality": {
"type": "string",
"example": "Milpitas",
"description": "The user's locality, often city."
},
"region": {
"type": "string",
"example": "California",
"description": "The user's region, often state."
},
"streetAddress": {
"type": "string",
"example": "1099 Bird Ave.",
"description": "The user's street."
},
"postalCode": {
"type": "string",
"example": "99212",
"description": "The user's postal or zip code."
}
}
},
"description": "A person's addresses."
},
"created": {
"type": "string",
"example": "2015-10-18T14:26:16.000Z",
"description": "The date and time the person was created."
},
"lastModified": {
"type": "string",
"example": "2015-10-18T14:26:16.000Z",
"description": "The date and time the person was last changed."
},
"timezone": {
"type": "string",
"example": "America/Denver",
"description": "The time zone of the person if configured. If no timezone is configured on the account, this field will not be present."
},
"lastActivity": {
"type": "string",
"example": "2015-10-18T14:26:16.028Z",
"description": "The date and time of the person's last activity within Webex. This will only be returned for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/)."
},
"siteUrls": {
"type": "array",
"items": {
"type": "string",
"example": "mysite.webex.com#attendee"
},
"description": "One or several site names where this user has a role (host or attendee)."
},
"sipAddresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"personal-room",
"enterprise",
"cloud-calling"
],
"description": "The type of SIP address.\n * `personal-room` - Personal room address.\n * `enterprise` - Enterprise address.\n * `cloud-calling` - Cloud calling address.\n"
},
"value": {
"type": "string",
"example": "testuser5@mycompany.webex.com",
"description": "The SIP address."
},
"primary": {
"type": "boolean",
"description": "Primary SIP address of the person."
}
}
},
"description": "The user's SIP addresses. Read-only."
},
"xmppFederationJid": {
"type": "string",
"example": "user@example.com",
"description": "Identifier for intra-domain federation with other XMPP based messenger systems."
},
"status": {
"type": "string",
"enum": [
"active",
"call",
"DoNotDisturb",
"inactive",
"meeting",
"OutOfOffice",
"pending",
"presenting",
"unknown"
],
"description": "The current presence status of the person. This will only be returned for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/). Presence status is different from Control Hub's \"Last Service Access Time\" which indicates the last time an oAuth token was issued for this user.\n * `active` - Active within the last 10 minutes.\n * `call` - The user is in a call.\n * `DoNotDisturb` - The user has manually set their status to \"Do Not Disturb\".\n * `inactive` - Last activity occurred more than 10 minutes ago.\n * `meeting` - The user is in a meeting.\n * `OutOfOffice` - The user or a Hybrid Calendar service has indicated that they are \"Out of Office\".\n * `pending` - The user has never logged in; a status cannot be determined.\n * `presenting` - The user is sharing content.\n * `unknown` - The user’s status could not be determined.\n"
},
"invitePending": {
"type": "string",
"enum": [
"true",
"false"
],
"description": "Whether or not an invite is pending for the user to complete account activation. This property is only returned if the authenticated user is an admin user for the person's organization.\n * `true` - The person has been invited to Webex but has not created an account.\n * `false` - An invite is not pending for this person.\n"
},
"loginEnabled": {
"type": "string",
"enum": [
"true",
"false"
],
"description": "Whether or not the user is allowed to use Webex. This property is only returned if the authenticated user is an admin user for the person's organization.\n * `true` - The person _can_ log into Webex.\n * `false` - The person _cannot_ log into Webex.\n"
},
"type": {
"type": "string",
"enum": [
"person",
"bot",
"appuser"
],
"description": "The type of person account, such as person or bot.\n * `person` - Account belongs to a person.\n * `bot` - Account is a bot user.\n * `appuser` - Account is a [guest user](/docs/guest-issuer).\n"
}
}
},
"PersonCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Person"
},
"description": "An array of person objects."
},
"notFoundIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of person IDs that could not be found."
}
}
},
"RecordingReportSummaryObject": {
"type": "object",
"properties": {
"recordingId": {
"type": "string",
"example": "4f914b1dfe3c4d11a61730f18c0f5387",
"description": "A unique identifier for the recording."
},
"topic": {
"type": "string",
"example": "John's Meeting",
"description": "The recording's topic."
},
"timeRecorded": {
"type": "string",
"example": "2019-01-27T17:40:20Z",
"description": "The date and time the recording started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. the time is the record button was clicked in the meeting."
},
"siteUrl": {
"type": "string",
"example": "site4-example.webex.com",
"description": "Site URL for the recording."
},
"hostEmail": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting host."
},
"viewCount": {
"type": "number",
"example": 7,
"description": "The number of times the recording was viewed."
},
"downloadCount": {
"type": "number",
"example": 20,
"description": "The number of times the recording was downloaded."
}
}
},
"RecordingReportObject": {
"type": "object",
"properties": {
"recordingId": {
"type": "string",
"example": "4f914b1dfe3c4d11a61730f18c0f5387",
"description": "A unique identifier for the recording."
},
"topic": {
"type": "string",
"example": "John's Meeting",
"description": "The recording's topic."
},
"name": {
"type": "string",
"example": "John Andersen",
"description": "The name of the person who accessed the recording."
},
"email": {
"type": "string",
"example": "john.andersen@example.com",
"description": "The email address of the person who accessed the recording."
},
"accessTime": {
"type": "string",
"example": "2019-01-27T17:40:20Z",
"description": "The date and time the recording was accessed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"viewed": {
"type": "boolean",
"example": true,
"description": "Whether or not the recording was viewed by the person."
},
"downloaded": {
"type": "boolean",
"example": true,
"description": "Whether or not the recording was downloaded by the person."
}
}
},
"RecordingAchriveSummaryObject": {
"type": "object",
"properties": {
"archiveId": {
"type": "string",
"example": "7d7ea5f42b921eace05386ca24ad730e_R_1000634462",
"description": "A unique identifier for the meeting archive summary."
},
"serviceType": {
"type": "string",
"enum": [
"MeetingCenter",
"EventCenter",
"TrainingCenter",
"SupportCenter"
],
"description": "Recording achrive summary's service-type."
},
"title": {
"type": "string",
"example": "John's Meeting",
"description": "Meeting title."
},
"createTime": {
"type": "string",
"example": "2019-01-27T17:43:24Z",
"description": "The date and time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format that when the archive was created by the system."
}
}
},
"RecordingArchiveReportObject": {
"type": "object",
"properties": {
"archiveId": {
"type": "string",
"example": "7d7ea5f42b921eace05386ca24ad730e_R_1000634462",
"description": "A unique identifier for the meeting archive summary."
},
"serviceType": {
"type": "string",
"enum": [
"MeetingCenter",
"EventCenter",
"TrainingCenter",
"SupportCenter"
],
"description": "Recording achrive report's service-type."
},
"title": {
"type": "string",
"example": "John's Meeting",
"description": "Meeting title."
},
"start": {
"type": "string",
"example": "2019-03-18T11:26:30Z",
"description": "Start time for meeting in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"end": {
"type": "string",
"example": "2019-03-18T12:26:30Z",
"description": "End time for a meeting in ISO 8601 compliant format."
},
"hostDisplayName": {
"type": "string",
"example": "John Andersen",
"description": "Display name for the meeting host."
},
"hostEmail": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting host."
},
"participants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveParticipant"
},
"description": "The participants of the meeting archive."
},
"chats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveChat"
},
"description": "The chats of the meeting archive."
},
"polls": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchivePoll"
},
"description": "The polls of the meeting archive."
},
"qas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveQA"
},
"description": "Meeting meeting archive's Q and A."
},
"systemInfos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveSystemInfo"
},
"description": "The system Information of the meeting archive, which can be only supported when serviceType is `SupportCenter`."
}
}
},
"MeetingRecordingArchiveParticipant": {
"type": "object",
"properties": {
"correlationId": {
"type": "number",
"example": 28208023,
"description": "An internal ID that is associated with each join."
},
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "Display name for the meeting participant."
},
"joinedTime": {
"type": "string",
"example": "2022-07-20T07:01:31Z",
"description": "The time the participant joined the meeting."
},
"leftTime": {
"type": "string",
"example": "2022-07-20T07:01:31Z",
"description": "The time the participant left the meeting."
},
"email": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting participant."
}
}
},
"MeetingRecordingArchiveChat": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "private",
"description": "Whether the type of the chat is private, public or group. Private chat is for the 1:1 chat. Public chat is for the message which is sent to all the people in the meeting. Group chat is for the message which is sent to a small group of people, like a message to the \"host and presenter\"."
},
"senderName": {
"type": "string",
"example": "John Andersen",
"description": "Display name for the sender of the chat snippet."
},
"chatTime": {
"type": "string",
"example": "2021-07-06T09:22:34Z",
"description": "Chat time for the chat snippet in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"target": {
"type": "string",
"example": "All Participants",
"description": "Information of the receivers of the chat snippet."
},
"text": {
"type": "string",
"example": "It's nice to meet you",
"description": "The text of the chat snippet."
}
}
},
"MeetingRecordingArchivePoll": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "single",
"description": "The type of the question."
},
"startTime": {
"type": "string",
"example": "2021-07-06T09:25:34Z",
"description": "The date and time the poll started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"endTime": {
"type": "string",
"example": "2021-07-06T09:28:34Z",
"description": "The date and time the poll ended in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"content": {
"type": "object",
"properties": {
"questionCount": {
"type": "number",
"example": 10,
"description": "The total number of questions."
},
"userCount": {
"type": "number",
"example": 10,
"description": "The total number of users."
},
"votedUserCount": {
"type": "number",
"example": 3,
"description": "The number of voters among users."
},
"questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchivePollQuestion"
},
"description": "Poll's questions."
}
},
"description": "The content of the meeting archive poll;"
}
}
},
"MeetingRecordingArchivePollQuestion": {
"type": "object",
"properties": {
"voteUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveUser"
},
"description": "The voters among users."
},
"question": {
"type": "object",
"properties": {
"choiceCount": {
"type": "number",
"example": 3,
"description": "The number of choices in the questions."
},
"type": {
"type": "string",
"example": "single",
"description": "The type of the question."
},
"text": {
"type": "string",
"example": "Do you like this API?",
"description": "The text of the question."
}
},
"description": "The poll's question."
},
"answerSummary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchivePollAnswerSummary"
},
"description": "The answer summary of the archive poll."
},
"respondents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchivePollRespondent"
},
"description": "The question's respondents."
}
}
},
"MeetingRecordingArchiveUser": {
"type": "object",
"properties": {
"correlationId": {
"type": "number",
"example": 28208023,
"description": "An internal ID that is associated with each join."
},
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "Display name for the meeting participant."
},
"email": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting participant."
}
}
},
"MeetingRecordingArchivePollAnswerSummary": {
"type": "object",
"properties": {
"totalRespondents": {
"type": "number",
"example": 10,
"description": "The total number of people who selected this answer."
},
"isCorrect": {
"type": "boolean",
"example": true,
"description": "Whether the answer is correct."
},
"text": {
"type": "string",
"example": "Yes, I do.",
"description": "The text of the answer."
},
"voteUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveUser"
},
"description": "The voters among users."
}
}
},
"MeetingRecordingArchivePollRespondent": {
"type": "object",
"properties": {
"correlationId": {
"type": "number",
"example": 28208023,
"description": "An internal ID that is associated with the respondent's each join."
},
"displayName": {
"type": "string",
"example": "Alex Green",
"description": "Display name for the poll respondent."
},
"email": {
"type": "string",
"example": "alex.green@example.com",
"description": "Email address for the poll respondent."
},
"answers": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of answers to the question."
}
}
},
"MeetingRecordingArchiveQA": {
"type": "object",
"properties": {
"priority": {
"type": "string",
"example": "NA",
"description": "The priority of the Q and A."
},
"type": {
"type": "string",
"example": "private",
"description": "Whether the type of the Q and A is private, public, or group. Private Q and A is for the 1:1 chat. Public Q and A are for the message which is sent to all the people in the meeting. Group Q and A are for the message which is sent to a small group of people, like a Q and A to \"host and presenter\"."
},
"displayName": {
"type": "string",
"example": "john.andersen@example.com`",
"description": "The email of the user who asked the question."
},
"questionTime": {
"type": "string",
"example": "2021-07-06T09:22:34Z",
"description": "The date and time the question was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"target": {
"type": "string",
"example": "All Participants",
"description": "Information of the user who asked the question."
},
"question": {
"type": "string",
"example": "Are you ok?",
"description": "The question that was asked."
},
"answers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveQAAnswer"
},
"description": "Question's answers."
}
}
},
"MeetingRecordingArchiveQAAnswer": {
"type": "object",
"properties": {
"responseMode": {
"type": "string",
"example": "private",
"description": "The answer's response mode."
},
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "The name of the person who answered the question."
},
"correlationId": {
"type": "number",
"example": 10947662,
"description": "An internal ID that is associated with the answer's each join."
},
"email": {
"type": "string",
"example": "alex.green@example.com",
"description": "The email of the person who answered the question."
},
"answerTime": {
"type": "string",
"example": "2021-07-06T09:52:34Z",
"description": "The date and time the question answered in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"text": {
"type": "string",
"example": "Yes, I am.",
"description": "The text of the answer."
}
}
},
"MeetingRecordingArchiveSystemInfo": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "The name of the person who accessed the meeting archive."
},
"catalogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SystemInfoCatalog"
},
"description": "The catalogs of system information."
}
}
},
"SystemInfoCatalog": {
"type": "object",
"properties": {
"systemSummary": {
"type": "string",
"example": "User Name: John{*}Operating System: Mac OS X 12.6{*}User Home Directory: /Users/John{*}Date and Time: Tue Oct 18 10:38:17 CST 2022{*}",
"description": "System summary."
},
"browser": {
"type": "string",
"example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36",
"description": "The browser user agent of the person who acted."
},
"hardware": {
"type": "string",
"example": "mac book",
"description": "The type of hardware that the user used to attend the meeting."
},
"installedSoftware": {
"type": "string",
"example": "webex",
"description": "The software that the user used to attend the meeting."
},
"runningSoftware": {
"type": "string",
"example": "webex",
"description": "The software the user used that is running."
},
"startupPrograms": {
"type": "string",
"example": "Macintosh HD",
"description": "Startup Programs."
},
"storage": {
"type": "string",
"example": "16 GB 2667 MHz DDR4",
"description": "The storage information of the user's device."
},
"video": {
"type": "string",
"example": "AirPlay",
"description": "The video of the user's device."
},
"network": {
"type": "string",
"example": "Wi-Fi",
"description": "The network of the user's device."
},
"operatingSystem": {
"type": "string",
"example": "Mac OS X 10.0",
"description": "The operating system of the user's device."
},
"environmentVariables": {
"type": "string",
"example": "/usr/local/bin:$PATH",
"description": "The environment variables of the user's device."
},
"processes": {
"type": "string",
"example": "2.6 GHz 6-Core Intel Core i7",
"description": "The processes of the user's device."
},
"logicalDrives": {
"type": "string",
"example": "webapp",
"description": "The logical drives of the user's device."
},
"devices": {
"type": "string",
"example": "device1",
"description": "The device of the user."
},
"services": {
"type": "string",
"example": "Firewall",
"description": "The service of the user's device."
},
"systemDrivers": {
"type": "string",
"example": "32drivers",
"description": "The system driver of the user's device."
},
"signedDrivers": {
"type": "string",
"example": "32drivers",
"description": "The sign driver system of the user's device."
},
"eventViewer": {
"type": "string",
"example": "Screen Sharing",
"description": "The event viewer of the user's device."
},
"bios": {
"type": "string",
"example": "AwardBIOS",
"description": "The basic input and output system."
}
}
},
"RecordingObject": {
"type": "object",
"required": [
"id",
"meetingId",
"topic",
"createTime",
"timeRecorded",
"siteUrl",
"downloadUrl",
"playbackUrl",
"password",
"format",
"serviceType",
"durationSeconds",
"sizeBytes",
"shareToMe",
"status"
],
"properties": {
"id": {
"type": "string",
"example": "4f914b1dfe3c4d11a61730f18c0f5387",
"description": "A unique identifier for the recording."
},
"meetingId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"description": "Unique identifier for the recording's ended meeting instance."
},
"scheduledMeetingId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"description": "Unique identifier for the recording's scheduled meeting instance."
},
"meetingSeriesId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291",
"description": "Unique identifier for the recording's meeting series."
},
"topic": {
"type": "string",
"example": "John's Meeting",
"description": "The recording's topic."
},
"createTime": {
"type": "string",
"example": "2019-01-27T17:43:24Z",
"description": "The date and time recording was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. Please note that it's not the time the record button was clicked in meeting but the time the recording file was generated offline."
},
"timeRecorded": {
"type": "string",
"example": "2019-01-27T17:40:20Z",
"description": "The date and time recording started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. It indicates when the record button was clicked in the meeting."
},
"siteUrl": {
"type": "string",
"example": "site4-example.webex.com",
"description": "Site URL for the recording."
},
"downloadUrl": {
"type": "string",
"example": "https://site4-example.webex.com/site4/lsr.php?RCID=60b864cc80aa5b44fc9769c8305b98b7",
"description": "The download link for recording. This attribute is not available if **Prevent downloading** has been turned on for the recording being requested. The **Prevent downloading** option can be viewed and set by a site admin on [Control Hub](https://help.webex.com/en-us/article/sxdj4ab/Manage-Security-for-a-Cisco-Webex-Site-in-Cisco-Webex-Control-Hub)."
},
"playbackUrl": {
"type": "string",
"example": "https://site4-example.webex.com/site4/ldr.php?RCID=7a8a476b29a32cd1e06dfa6c81970f19",
"description": "The playback link for recording."
},
"password": {
"type": "string",
"example": "********",
"description": "The recording's password."
},
"format": {
"type": "string",
"enum": [
"MP4",
"ARF",
"UPLOADED"
],
"description": " * `MP4` - Recording file format is MP4.\n * `ARF` - Recording file format is ARF, a proprietary Webex recording format.\n * `UPLOADED` - The recording file is uploaded manually.\n"
},
"serviceType": {
"type": "string",
"enum": [
"MeetingCenter",
"EventCenter",
"TrainingCenter",
"SupportCenter"
],
"description": "The service type for the recording.\n * `MeetingCenter` - The service type for the recording is meeting.\n * `EventCenter` - The service type for the recording is the event.\n * `TrainingCenter` - The service type for the recording is the training session.\n * `SupportCenter` - The service type for the recording is the support meeting.\n"
},
"durationSeconds": {
"type": "number",
"example": 4472,
"description": "The duration of the recording, in seconds."
},
"sizeBytes": {
"type": "number",
"example": 248023188,
"description": "The size of the recording file, in bytes."
},
"shareToMe": {
"type": "boolean",
"description": "Whether or not the recording has been shared to the current user. This attribute is hidden if the user calling the API is a Compliance Officer and `hostEmail` is not specified."
},
"integrationTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "External keys of the parent meeting created by an integration application. They could be Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc. The integration application queries recordings by a key in its own domain."
},
"status": {
"type": "string",
"enum": [
"available",
"deleted",
"purged"
],
"description": " * `available` - Recording is available.\n * `deleted` - Recording has been moved into recycle bin.\n * `purged` - Recording has been purged from the recycle bin. Only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.\n"
}
}
},
"RecordingObjectForAdminAndCO": {
"type": "object",
"required": [
"id",
"meetingId",
"topic",
"createTime",
"timeRecorded",
"hostDisplayName",
"hostEmail",
"siteUrl",
"downloadUrl",
"playbackUrl",
"format",
"serviceType",
"durationSeconds",
"sizeBytes",
"status"
],
"properties": {
"id": {
"type": "string",
"example": "4f914b1dfe3c4d11a61730f18c0f5387",
"description": "A unique identifier for the recording."
},
"meetingId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"description": "Unique identifier for the recording's ended meeting instance."
},
"scheduledMeetingId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"description": "Unique identifier for the recording's scheduled meeting instance."
},
"meetingSeriesId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291",
"description": "Unique identifier for the recording's meeting series."
},
"topic": {
"type": "string",
"example": "John's Meeting",
"description": "The recording's topic."
},
"createTime": {
"type": "string",
"example": "2019-01-27T17:43:24Z",
"description": "The date and time recording was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. Please note that it's not the time the record button was clicked in meeting but the time the recording file was generated offline."
},
"timeRecorded": {
"type": "string",
"example": "2019-01-27T17:40:20Z",
"description": "The date and time recording started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. It indicates when the record button was clicked in the meeting."
},
"hostDisplayName": {
"type": "string",
"example": "John Andersen",
"description": "Display name for the meeting host."
},
"hostEmail": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting host."
},
"siteUrl": {
"type": "string",
"example": "site4-example.webex.com",
"description": "Site URL for the recording."
},
"downloadUrl": {
"type": "string",
"example": "https://site4-example.webex.com/site4/lsr.php?RCID=60b864cc80aa5b44fc9769c8305b98b7",
"description": "The download link for recording. This attribute is not available if **Prevent downloading** has been turned on for the recording being requested. The **Prevent downloading** option can be viewed and set by a site admin on [Control Hub](https://help.webex.com/en-us/article/sxdj4ab/Manage-Security-for-a-Cisco-Webex-Site-in-Cisco-Webex-Control-Hub)."
},
"playbackUrl": {
"type": "string",
"example": "https://site4-example.webex.com/site4/ldr.php?RCID=7a8a476b29a32cd1e06dfa6c81970f19",
"description": "The playback link for recording."
},
"format": {
"type": "string",
"enum": [
"MP4",
"ARF",
"UPLOADED"
],
"description": " * `MP4` - Recording file format is MP4.\n * `ARF` - Recording file format is ARF, a proprietary Webex recording format.\n * `UPLOADED` - The recording file is uploaded manually.\n"
},
"serviceType": {
"type": "string",
"enum": [
"MeetingCenter",
"EventCenter",
"TrainingCenter",
"SupportCenter"
],
"description": "The service type for the recording.\n * `MeetingCenter` - The service type for the recording is meeting.\n * `EventCenter` - The service type for the recording is the event.\n * `TrainingCenter` - The service type for the recording is the training session.\n * `SupportCenter` - The service type for the recording is the support meeting.\n"
},
"durationSeconds": {
"type": "number",
"example": 4472,
"description": "The duration of the recording, in seconds."
},
"sizeBytes": {
"type": "number",
"example": 248023188,
"description": "The size of the recording file, in bytes."
},
"integrationTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "External keys of the parent meeting created by an integration application. They could be Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc. The integration application queries recordings by a key in its own domain."
},
"status": {
"type": "string",
"enum": [
"available",
"deleted",
"purged"
],
"description": " * `available` - Recording is available.\n * `deleted` - Recording has been moved into recycle bin.\n * `purged` - Recording has been purged from the recycle bin. Please note that only a compliance officer can access recordings with a `purged` status.\n"
}
}
},
"RecordingObjectWithDirectDownloadLinks": {
"type": "object",
"required": [
"id",
"meetingId",
"topic",
"createTime",
"timeRecorded",
"siteUrl",
"downloadUrl",
"playbackUrl",
"password",
"format",
"serviceType",
"durationSeconds",
"sizeBytes",
"shareToMe",
"status"
],
"properties": {
"id": {
"type": "string",
"example": "7ee40776779243b4b3da448d941b34dc",
"description": "A unique identifier for recording."
},
"meetingId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"description": "Unique identifier for the recording's ended meeting instance."
},
"scheduledMeetingId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"description": "Unique identifier for the recording's scheduled meeting instance."
},
"meetingSeriesId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291",
"description": "Unique identifier for the recording's meeting series."
},
"topic": {
"type": "string",
"example": "John's Meeting",
"description": "The recording's topic."
},
"createTime": {
"type": "string",
"example": "2019-01-27T17:43:24Z",
"description": "The date and time recording was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. Please note that it's not the time the record button was clicked in meeting but the time the recording file was generated offline."
},
"timeRecorded": {
"type": "string",
"example": "2019-01-27T17:40:20Z",
"description": "The date and time recording started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. It indicates when the record button was clicked in the meeting."
},
"siteUrl": {
"type": "string",
"example": "site4-example.webex.com",
"description": "Site URL for the recording."
},
"downloadUrl": {
"type": "string",
"example": "https://site4-example.webex.com/site4/lsr.php?RCID=60b864cc80aa5b44fc9769c8305b98b7",
"description": "The download link for the recording. This attribute is not available if `prevent downloading` has been turned on for the recording being requested. The `prevent downloading` option can be viewed and set on page when editing a recording."
},
"playbackUrl": {
"type": "string",
"example": "https://site4-example.webex.com/site4/ldr.php?RCID=7a8a476b29a32cd1e06dfa6c81970f19",
"description": "The playback link for recording."
},
"password": {
"type": "string",
"example": "********",
"description": "The recording's password."
},
"format": {
"type": "string",
"enum": [
"MP4",
"ARF",
"UPLOADED"
],
"description": " * `MP4` - Recording file format is MP4.\n * `ARF` - Recording file format is ARF, a proprietary Webex recording format.\n * `UPLOADED` - The recording file is uploaded manually.\n"
},
"serviceType": {
"type": "string",
"enum": [
"MeetingCenter",
"EventCenter",
"TrainingCenter",
"SupportCenter"
],
"description": " * `MeetingCenter` - The service type for the recording is meeting.\n * `EventCenter` - The service type for the recording is the event.\n * `TrainingCenter` - The service type for the recording is the training session.\n * `SupportCenter` - The service type for the recording is the support meeting.\n"
},
"durationSeconds": {
"type": "number",
"example": 4472,
"description": "The duration of the recording in seconds."
},
"sizeBytes": {
"type": "number",
"example": 248023188,
"description": "The size of the recording file in bytes."
},
"shareToMe": {
"type": "boolean",
"description": "Whether or not the recording has been shared to the current user."
},
"temporaryDirectDownloadLinks": {
"type": "object",
"properties": {
"recordingDownloadLink": {
"type": "string",
"description": "The download link for recording MP4/ARF file without HTML page rendering in browser or HTTP redirect. Expires 3 hours after the API request."
},
"audioDownloadLink": {
"type": "string",
"description": "The download link for recording audio file without HTML page rendering in browser or HTTP redirect. This attribute is not available if **Prevent Downloading** has been turned on for the recording being requested. Expires 3 hours after the API request."
},
"transcriptDownloadLink": {
"type": "string",
"description": "The download link for recording transcript file without HTML page rendering in browser or HTTP redirect. This attribute is not available if **Prevent Downloading** has been turned on for the recording being requested. Expires 3 hours after the API request."
},
"expiration": {
"type": "string",
"description": "The date and time when `recordingDownloadLink`, `audioDownloadLink`, and `transcriptDownloadLink` expire in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
}
},
"description": "The download links for MP4/ARF, audio, and transcript of the recording without HTML page rendering in browser or HTTP redirect. This attribute is not available if the user is not a [Compliance Officer](/docs/compliance#compliance) and **Prevent Downloading** has been turned on for the recording being requested. The Prevent Downloading option can be viewed and set on page when editing a recording. Note that there are various products in [Webex Suite](https://www.cisco.com/c/en/us/products/conferencing/product_comparison.html) such as \"Webex Meetings\", \"Webex Training\" and \"Webex Events\"."
},
"integrationTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "External keys of the parent meeting created by an integration application. The key can be Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc. The integration application queries recordings by a key in its own domain."
},
"status": {
"type": "string",
"enum": [
"available",
"deleted",
"purged"
],
"description": " * `available` - Recording is available.\n * `deleted` - Recording has been moved to the recycle bin.\n * `purged` - Recording has been purged from the recycle bin. Please note that only a compliance officer can access recordings with a `purged` status.\n"
}
}
},
"DeleteRecordingObject": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"example": "audit",
"description": "Reason for deleting a recording. Only required when a Compliance Officer is operating on another user's recording."
},
"comment": {
"type": "string",
"example": "Maintain data privacy",
"description": "Compliance Officer's explanation for deleting a recording. The comment can be a maximum of 255 characters long."
}
}
},
"BulkSoftDeleteRecordingObject": {
"type": "object",
"required": [
"recordingIds"
],
"properties": {
"recordingIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Recording IDs for removing recordings into the recycle bin in batch. Please note that all the recording IDs should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified."
},
"siteUrl": {
"type": "string",
"example": "example.webex.com",
"description": "URL of the Webex site from which the API deletes recordings. If not specified, the API deletes recordings from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API."
}
}
},
"BulkRestoreRecordingObject": {
"type": "object",
"properties": {
"restoreAll": {
"type": "boolean",
"description": "If not specified or `false`, restores the recordings specified by `recordingIds`. If `true`, restores all recordings from the recycle bin."
},
"recordingIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Recording IDs for recovering recordings from the recycle bin in batch. Note that all the recording IDs should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified."
},
"siteUrl": {
"type": "string",
"example": "example.webex.com",
"description": "URL of the Webex site from which the API restores recordings. If not specified, the API restores recordings from a user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API."
}
}
},
"BulkPurgeRecordingObject": {
"type": "object",
"properties": {
"purgeAll": {
"type": "boolean",
"description": "If not specified or `false`, purges the recordings specified by `recordingIds`. If `true`, purges all recordings from the recycle bin."
},
"recordingIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Recording IDs for purging recordings from the recycle bin in batch. Note that all the recording IDs should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified."
},
"siteUrl": {
"type": "string",
"example": "example.webex.com",
"description": "URL of the Webex site from which the API purges recordings. If not specified, the API purges recordings from user's preferred site. All available Webex sites and preferred sites of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API."
}
}
},
"ShareRecordingByIdObject": {
"type": "object",
"properties": {
"hostEmail": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin-level scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host. The field is not editable and is only used to share or unshare a recording on behalf of the real meeting host."
},
"addEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Email addresses of users to share the recording with. The maximum size of the array is `100`."
},
"removeEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Email addresses of users to unshare the recording with. The maximum size of the array is `100`."
},
"sendEmail": {
"type": "boolean",
"description": "Whether to send email notifications to the users being shared. The default is `true`."
}
}
},
"ShareRecordingByLinkObject": {
"type": "object",
"properties": {
"hostEmail": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin-level scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host. The field is not editable and is only used to share or unshare a recording link on behalf of the real meeting host."
},
"webShareLink": {
"type": "string",
"example": "https://example.webex.com/recordingservice/sites/example/recording/playback/1234567890abcdef1234567890abcdef",
"description": "The link for the recording to be shared or unshared."
},
"addEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Email addresses of users to share the recording link with. The maximum size of the array is `100`."
},
"removeEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Email addresses of users to unshare the recording link with. The maximum size of the array is `100`."
},
"sendEmail": {
"type": "boolean",
"description": "Whether to send email notifications to the users being shared. The default is `true`."
}
}
},
"Webhook": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1dFQkhPT0svOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"description": "A unique identifier for the webhook."
},
"name": {
"type": "string",
"example": "My Awesome Webhook",
"description": "A user-friendly name for the webhook."
},
"targetUrl": {
"type": "string",
"example": "https://example.com/mywebhook",
"description": "URL that receives POST requests for each event."
},
"resource": {
"type": "string",
"enum": [
"attachmentActions",
"dataSources",
"memberships",
"messages",
"rooms",
"meetings",
"recordings",
"convergedRecordings",
"meetingParticipants",
"meetingTranscripts",
"telephony_calls",
"telephony_conference",
"telephony_mwi",
"uc_counters",
"serviceApp",
"adminBatchJobs"
],
"description": "Resource type for the webhook. Creating a webhook requires 'read' scope on the resource the webhook is for.\n * `attachmentActions` - [Attachment Actions](/docs/api/v1/attachment-actions) resource.\n * `dataSources` - [data sources](/docs/api/v1/data-sources) resource.\n * `memberships` - [Memberships](/docs/api/v1/memberships) resource.\n * `messages` - [Messages](/docs/api/v1/messages) resource.\n * `rooms` - [Rooms](/docs/api/v1/rooms) resource.\n * `meetings` - [Meetings](/docs/api/v1/meetings) resource.\n * `recordings` - [Recordings](/docs/api/v1/recordings) resource.\n * `convergedRecordings` - [CallRecordings](/docs/api/v1/converged-recordings) resource.\n * `meetingParticipants` - [Meeting Participants](/docs/api/v1/meeting-participants) resource.\n * `meetingTranscripts` - [Meeting Transcripts](/docs/api/v1/meeting-transcripts) resource.\n * `telephony_calls` - [Webex Calling](/docs/webex-calling-overview) call resources.\n * `telephony_conference` - [Webex Calling](/docs/webex-calling-overview) conference controls resource.\n * `telephony_mwi` - [Webex Calling](/docs/webex-calling-overview) voicemail message waiting indicator resource.\n * `uc_counters` - Performance counter for a dedicated instance.\n * `serviceApp` - Service App authorization notification.\n * `adminBatchJobs` - Admin Batch Jobs notification.\n"
},
"event": {
"type": "string",
"enum": [
"created",
"updated",
"deleted",
"started",
"ended",
"joined",
"left",
"migrated",
"authorized",
"deauthorized",
"statusChanged"
],
"description": "Event type for the webhook.\n * `created` - An object was created.\n * `updated` - An object was updated.\n * `deleted` - An object was deleted.\n * `started` - A meeting was started.\n * `ended` - A meeting was ended.\n * `joined` - A participant joined.\n * `left` - A participant left.\n * `migrated` - A room was migrated to a different geography. The roomId has changed.\n * `authorized` - A Service App was authorized.\n * `deauthorized` - A Service App was deauthorized.\n * `statusChanged` - Status of admin batch job was changed.\n"
},
"filter": {
"type": "string",
"example": "roomId=Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
"description": "Filter that defines the webhook scope."
},
"secret": {
"type": "string",
"example": "86dacc007724d8ea666f88fc77d918dad9537a15",
"description": "Secret used to generate payload signature."
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
],
"description": "Status of the webhook. Use `active` to reactivate a disabled webhook.\n * `active` - Webhook is active.\n * `inactive` - Webhook is inactive.\n"
},
"created": {
"type": "string",
"example": "2015-10-18T14:26:16+00:00",
"description": "Date and time the webhook was created."
},
"ownedBy": {
"type": "string",
"example": "org",
"description": "Specify `org` when creating an org/admin level webhook. Supported for `meetings`, `recordings`, `convergedRecordings`, `meetingParticipants`, `meetingTranscripts`, `videoMeshAlerts`, `controlHubAlerts`, `rooms`, `messaging` and `adminBatchJobs` (for Compliance Officers and messages with file attachments only - see [inline file DLP](/docs/api/guides/webex-real-time-file-dlp-basics)) resources."
}
}
},
"WebhookCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Webhook"
}
}
}
},
"WorkspaceLocationsCreationRequest": {
"type": "object",
"required": [
"displayName",
"address",
"countryCode",
"latitude",
"longitude"
],
"properties": {
"displayName": {
"type": "string",
"example": "Cisco Barcelona",
"description": "A friendly name for the location."
},
"address": {
"type": "string",
"example": "Carrer de Pere IV, Barcelona, Spain",
"description": "The location address."
},
"countryCode": {
"type": "string",
"example": "ES",
"description": "The location country code (ISO 3166-1)."
},
"cityName": {
"type": "string",
"example": "Barcelona",
"description": "The location city name."
},
"latitude": {
"type": "number",
"example": 41.406615,
"description": "The location latitude."
},
"longitude": {
"type": "number",
"example": 2.200717,
"description": "The location longitude."
},
"notes": {
"type": "string",
"example": "A note about the location",
"description": "Notes associated with the location."
}
}
},
"WorkspaceLocationsUpdateRequest": {
"type": "object",
"required": [
"displayName",
"address",
"countryCode",
"latitude",
"longitude"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"description": "Unique identifier for the location."
},
"displayName": {
"type": "string",
"example": "Cisco Barcelona",
"description": "A friendly name for the location."
},
"address": {
"type": "string",
"example": "Carrer de Pere IV, Barcelona, Spain",
"description": "The location address."
},
"countryCode": {
"type": "string",
"example": "ES",
"description": "The location country code (ISO 3166-1)."
},
"cityName": {
"type": "string",
"example": "Barcelona",
"description": "The location city name."
},
"latitude": {
"type": "number",
"example": 41.406615,
"description": "The location latitude."
},
"longitude": {
"type": "number",
"example": 2.200717,
"description": "The location longitude."
},
"notes": {
"type": "string",
"example": "A note about the location",
"description": "Notes associated with the location."
}
}
},
"WorkspaceLocationsCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location"
},
"description": "An array of location objects."
}
}
},
"WorkspaceLocationFloorsCreationRequest": {
"type": "object",
"required": [
"floorNumber"
],
"properties": {
"floorNumber": {
"type": "number",
"example": -1,
"description": "The floor number."
},
"displayName": {
"type": "string",
"example": "The basement",
"description": "The floor display name."
}
}
},
"WorkspaceLocationFloorsUpdateRequest": {
"type": "object",
"required": [
"floorNumber"
],
"properties": {
"floorNumber": {
"type": "number",
"example": 1,
"description": "The floor number."
},
"displayName": {
"type": "string",
"example": "My custom name",
"description": "The floor display name."
}
}
},
"WorkspaceLocationFloorsCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Floor"
},
"description": "An array of floor objects."
}
}
},
"WorkspaceMetricsResponse": {
"type": "object",
"required": [
"workspaceId",
"metricName"
],
"properties": {
"workspaceId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE"
},
"metricName": {
"type": "string",
"enum": [
"soundLevel",
"ambientNoise",
"temperature",
"humidity",
"tvoc",
"peopleCount"
]
},
"aggregation": {
"type": "string",
"enum": [
"none",
"hourly",
"daily"
]
},
"from": {
"type": "string",
"example": "2020-10-21T13:33:37.789Z"
},
"to": {
"type": "string",
"example": "2020-10-31T16:00:00.532Z"
},
"unit": {
"type": "string",
"enum": [
"celsius",
"fahrenheit"
],
"description": "Output data unit (only present if `metricName` is `temperature`)."
},
"sortBy": {
"type": "string",
"enum": [
"newestFirst",
"oldestFirst"
]
},
"items": {
"type": "array",
"items": {},
"description": "The structure of the elements will depend on whether or not aggregated data was requested"
}
}
},
"DurationMetric": {
"type": "object",
"properties": {
"start": {
"type": "string",
"example": "2021-10-21T12:00:00Z",
"description": "Timestamp indicating the start of the aggregation bucket (ISO 8601)."
},
"end": {
"type": "string",
"example": "2021-10-21T13:00:00Z",
"description": "Timestamp indicating the end of the aggregation bucket (ISO 8601)."
},
"duration": {
"type": "number",
"example": 13,
"description": "The time duration (in a given state) in the bucket."
}
}
},
"WorkspaceDurationMetricsResponse": {
"type": "object",
"required": [
"workspaceId"
],
"properties": {
"workspaceId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE"
},
"aggregation": {
"type": "string",
"enum": [
"hourly",
"daily"
]
},
"measurement": {
"type": "string",
"enum": [
"timeUsed",
"timeBooked"
]
},
"from": {
"type": "string",
"example": "2020-10-21T13:33:37.789Z"
},
"to": {
"type": "string",
"example": "2020-10-31T16:00:00.532Z"
},
"unit": {
"type": "string",
"example": "minutes",
"description": "The time unit."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DurationMetric"
}
}
}
},
"WorkspaceIssue": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Issue id."
},
"createdAt": {
"type": "string",
"description": "Issue created timestamp."
},
"title": {
"type": "string",
"description": "Issue title."
},
"description": {
"type": "string",
"description": "Issue description."
},
"recommendedAction": {
"type": "string",
"description": "Recommended action to mitigate issue."
},
"level": {
"type": "object",
"properties": {
"Members": {
"type": "string",
"enum": [
"error",
"warning",
"info"
]
}
},
"description": "Issue level."
}
}
},
"Workspace": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc",
"description": "Unique identifier for the Workspace."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
"description": "`OrgId` associated with the workspace."
},
"locationId": {
"type": "string",
"example": "Y2lzY29...",
"description": "Location associated with the workspace (ID to use for the [/locations API](/docs/api/v1/locations))."
},
"workspaceLocationId": {
"type": "string",
"example": "YL34GrT...",
"description": "Legacy workspace location ID associated with the workspace. Prefer `locationId`."
},
"floorId": {
"type": "string",
"example": "Y2lzY29z...",
"description": "Floor associated with the workspace."
},
"displayName": {
"type": "string",
"example": "SFO-12 Capanina",
"description": "A friendly name for the workspace."
},
"capacity": {
"type": "number",
"example": 5,
"description": "How many people the workspace is suitable for."
},
"type": {
"type": "string",
"enum": [
"notSet",
"focus",
"huddle",
"meetingRoom",
"open",
"desk",
"other"
],
"description": "The workspace type.\n * `notSet` - No workspace type set.\n * `focus` - High concentration.\n * `huddle` - Brainstorm/collaboration.\n * `meetingRoom` - Dedicated meeting space.\n * `open` - Unstructured agile.\n * `desk` - Individual.\n * `other` - Unspecified.\n"
},
"sipAddress": {
"type": "string",
"example": "test_workspace_1@trialorg.room.ciscospark.com",
"description": "`SipUrl` to call all the devices associated with the workspace."
},
"created": {
"type": "string",
"example": "2016-04-21T17:00:00.000Z",
"description": "The date and time that the workspace was registered, in ISO8601 format."
},
"calling": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"freeCalling",
"hybridCalling",
"webexCalling",
"webexEdgeForDevices",
"thirdPartySipCalling",
"none"
],
"description": "Calling.\n * `freeCalling` - Free Calling.\n * `hybridCalling` - Hybrid Calling.\n * `webexCalling` - Webex Calling.\n * `webexEdgeForDevices` - Webex Edge For Devices.\n * `thirdPartySipCalling` - Third-party SIP URI.\n * `none` - No Calling.\n"
},
"hybridCalling": {
"type": "object",
"properties": {
"emailAddress": {
"type": "string",
"example": "workspace@example.com",
"description": "End user email address in Cisco Unified CM."
}
},
"description": "The `hybridCalling` object only applies when calling type is `hybridCalling`."
},
"webexCalling": {
"type": "object",
"properties": {
"licenses": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29g4..."
},
"description": "The Webex Calling license associated with this workspace."
}
},
"description": "The `webexCalling` object only applies when calling type is `webexCalling`."
}
},
"description": "Calling type."
},
"calendar": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"none",
"google",
"microsoft"
],
"description": " * `none` - No calendar.\n * `google` - Google Calendar.\n * `microsoft` - Microsoft Exchange or Office 365.\n"
},
"emailAddress": {
"type": "string",
"example": "workspace@example.com",
"description": "Workspace email address. Will not be set when the calendar type is `none`."
}
},
"description": "Calendar type. Calendar of type `none` does not include an `emailAddress` field."
},
"notes": {
"type": "string",
"example": "this is a note",
"description": "Notes associated to the workspace."
},
"hotdeskingStatus": {
"type": "string",
"enum": [
"on",
"off"
],
"description": "Hot desking status of the workspace.\n * `on` - Workspace supports hotdesking.\n * `off` - Workspace does not support hotdesking.\n"
},
"supportedDevices": {
"type": "string",
"enum": [
"collaborationDevices",
"phones"
],
"description": "The supported devices for the workspace. Default is `collaborationDevices`.\n * `collaborationDevices` - Workspace supports collaboration devices.\n * `phones` - Workspace supports MPP phones.\n"
},
"deviceHostedMeetings": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "`true` if enabled or `false` otherwise."
},
"siteUrl": {
"type": "string",
"example": "'example.webex.com'",
"description": "The Webex site for the device hosting meetings."
}
},
"description": "Device hosted meetings configuration."
},
"devicePlatform": {
"type": "string",
"enum": [
"cisco",
"microsoftTeamsRoom"
],
"description": "The device platform.\n * `cisco` - Cisco.\n * `microsoftTeamsRoom` - Microsoft Teams Room.\n"
},
"indoorNavigation": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "URL of a map locating the workspace."
}
},
"description": "Indoor navigation configuration."
},
"health": {
"type": "object",
"properties": {
"level": {
"type": "string",
"enum": [
"error",
"warning",
"info",
"ok"
],
"description": "Health level. The level is based on the list of issues associated with the workspace."
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkspaceIssue"
},
"description": "A list of workspace issues."
}
},
"description": "The health of the workspace."
},
"devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Device"
},
"description": "A list of devices associated with the workspace."
},
"capabilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CapabilityMap"
},
"description": "The map of workspace capabilities."
},
"plannedMaintenance": {
"type": "object",
"description": "The planned maintenance for the workspace.",
"properties": {
"mode": {
"type": "string",
"enum": [
"off",
"on",
"upcoming"
],
"description": "The planned maintenance mode for the workspace"
},
"startTime": {
"type": "string",
"example": "2026-10-01T00:00:00.000Z",
"description": "The start of the planned maintenance period."
},
"endTime": {
"type": "string",
"example": "2026-10-02T00:00:00.000Z",
"description": "The end of the planned maintenance period."
}
}
}
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
"locationId": "YL34GrT...",
"workspaceLocationId": "YL34GrT...",
"floorId": "Y2lzY29z...",
"displayName": "SFO-12 Capanina",
"capacity": 5,
"sipAddress": ""
}
},
"WorkspaceCreationRequest": {
"type": "object",
"required": [
"displayName"
],
"properties": {
"displayName": {
"type": "string",
"example": "SFO-12 Capanina",
"description": "A friendly name for the workspace."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
"description": "`OrgId` associated with the workspace. Only admin users of another organization (such as partners) may use this parameter."
},
"locationId": {
"type": "string",
"example": "YL34GrT...",
"description": "Location associated with the workspace. Must be provided when the `floorId` is set."
},
"workspaceLocationId": {
"type": "string",
"example": "YL34GrT...",
"description": "Legacy workspace location ID associated with the workspace. Prefer `locationId`."
},
"floorId": {
"type": "string",
"example": "Y2lzY29z...",
"description": "Floor associated with the workspace."
},
"capacity": {
"type": "number",
"example": 5,
"description": "How many people the workspace is suitable for. If set, must be 0 or higher."
},
"type": {
"type": "string",
"enum": [
"notSet",
"focus",
"huddle",
"meetingRoom",
"open",
"desk",
"other"
],
"description": "The type that best describes the workspace.\n * `notSet` - No workspace type set.\n * `focus` - High concentration.\n * `huddle` - Brainstorm/collaboration.\n * `meetingRoom` - Dedicated meeting space.\n * `open` - Unstructured agile.\n * `desk` - Individual.\n * `other` - Unspecified.\n"
},
"sipAddress": {
"type": "string",
"description": "The `sipAddress` field can only be provided when calling type is `thirdPartySipCalling`."
},
"calling": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"freeCalling",
"hybridCalling",
"webexCalling",
"webexEdgeForDevices",
"thirdPartySipCalling",
"none"
],
"description": "The calling type that is supported on the workspace.\n * `freeCalling` - Free Calling (Default).\n * `hybridCalling` - Hybrid Calling.\n * `webexCalling` - Webex Calling.\n * `webexEdgeForDevices` - Webex Edge For Devices.\n * `thirdPartySipCalling` - Third-party SIP URI.\n * `none` - No Calling.\n"
},
"webexCalling": {
"type": "object",
"properties": {
"phoneNumber": {
"type": "string",
"example": "+12145654032",
"description": "End user phone number."
},
"extension": {
"type": "string",
"example": "28278",
"description": "End user extension."
},
"locationId": {
"type": "string",
"example": "Y2lzY29g4...",
"description": "Calling location ID."
},
"licenses": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29g4...1,Y2lzY29g4...2,Y2lzY29g4...n"
},
"description": "A list of Webex Calling License IDs. If multiple license IDs are provided, the oldest suitable one will be applied."
}
},
"description": "The `webexCalling` object only applies when calling type is `webexCalling`."
}
},
"description": "Calling."
},
"calendar": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "microsoft"
},
"emailAddress": {
"type": "string",
"example": "workspace@example.com",
"description": "Workspace email address. Will not be set when the calendar type is `none`."
},
"resourceGroupId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOk5vcndheS9SRVNPVVJDRV9HUk9VUC9jOGFiMDJhNC01NjI5LTRiNTctOGUyNy03ZDZkZjJlN2YzNzA=",
"description": "The `ResourceGroup` ID is associated with the workspace and is only applicable for on-premise MICROSOFT calendar."
}
},
"description": "Workspace calendar configuration requires a `type` (`microsoft`, `google`, or `none`), an `emailAddress`, and a `resourceGroupId`. The default is `none`."
},
"notes": {
"type": "string",
"example": "this is a note",
"description": "Notes associated to the workspace."
},
"hotdeskingStatus": {
"type": "string",
"enum": [
"on",
"off"
],
"description": "Hot desking status of the workspace.\n * `on` - Workspace supports hotdesking.\n * `off` - Workspace does not support hotdesking.\n"
},
"deviceHostedMeetings": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Set to `true` to enable or `false` to disable."
},
"siteUrl": {
"type": "string",
"example": "'example.webex.com'",
"description": "The Webex site for device hosting meetings."
}
},
"description": "To enable device hosted meetings, set a Webex `siteUrl` and the `enabled` flag to `true`."
},
"supportedDevices": {
"type": "string",
"enum": [
"collaborationDevices",
"phones"
],
"description": "The supported devices for the workspace. Default is `collaborationDevices`.\n * `collaborationDevices` - Workspace supports collaboration devices.\n * `phones` - Workspace supports MPP phones.\n"
},
"indoorNavigation": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "URL of a map locating the workspace."
}
},
"description": "Indoor navigation configuration."
}
}
},
"WorkspaceUpdateRequest": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"example": "SFO-12 Capanina",
"description": "A friendly name for the workspace."
},
"locationId": {
"type": "string",
"example": "YL34GrT...",
"description": "Location associated with the workspace. Must be provided when the `floorId` is set."
},
"workspaceLocationId": {
"type": "string",
"example": "YL34GrT...",
"description": "Legacy workspace location ID associated with the workspace. Prefer `locationId`."
},
"floorId": {
"type": "string",
"example": "Y2lzY29z...",
"description": "Floor associated with the workspace."
},
"capacity": {
"type": "number",
"example": 5,
"description": "How many people the workspace is suitable for. If set, must be 0 or higher."
},
"type": {
"type": "string",
"enum": [
"notSet",
"focus",
"huddle",
"meetingRoom",
"open",
"desk",
"other"
],
"description": "The type that best describes the workspace.\n * `notSet` - No workspace type set.\n * `focus` - High concentration.\n * `huddle` - Brainstorm/collaboration.\n * `meetingRoom` - Dedicated meeting space.\n * `open` - Unstructured agile.\n * `desk` - Individual.\n * `other` - Unspecified.\n"
},
"calendar": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "microsoft"
},
"emailAddress": {
"type": "string",
"example": "workspace@example.com",
"description": "Workspace email address. Will not be set when the calendar type is `none`."
},
"resourceGroupId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOk5vcndheS9SRVNPVVJDRV9HUk9VUC9jOGFiMDJhNC01NjI5LTRiNTctOGUyNy03ZDZkZjJlN2YzNzA=",
"description": "The `ResourceGroup` ID is associated with the workspace and is only applicable for on-premise MICROSOFT calendar."
}
},
"description": "An empty or null `calendar` field will not cause any changes. Provide a `type` (`microsoft`, `google`, or `none`), an `emailAddress`, and a `resourceGroupId`. To remove a calendar, set the `type` to `none`; this does not require an `emailAddress` or `resourceGroupId`."
},
"sipAddress": {
"type": "string",
"description": "The `sipAddress` field can only be provided when calling type is `thirdPartySipCalling`."
},
"calling": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"freeCalling",
"hybridCalling",
"webexCalling",
"webexEdgeForDevices",
"thirdPartySipCalling",
"none"
],
"description": "The calling type that is supported on the workspace.\n * `freeCalling` - Free Calling (Default).\n * `hybridCalling` - Hybrid Calling.\n * `webexCalling` - Webex Calling.\n * `webexEdgeForDevices` - Webex Edge For Devices.\n * `thirdPartySipCalling` - Third-party SIP URI.\n * `none` - No Calling.\n"
},
"webexCalling": {
"type": "object",
"properties": {
"phoneNumber": {
"type": "string",
"example": "+12145654032",
"description": "End user phone number."
},
"extension": {
"type": "string",
"example": "28278",
"description": "End user extension."
},
"locationId": {
"type": "string",
"example": "Y2lzY29g4...",
"description": "Calling location ID."
},
"licenses": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29g4...1,Y2lzY29g4...2,Y2lzY29g4...n"
},
"description": "A list of Webex Calling license IDs. If multiple license IDs are provided, the oldest suitable one will be applied."
}
},
"description": "The `webexCalling` object only applies when calling type is `webexCalling`."
}
},
"description": "Calling types supported on update are `freeCalling`, `thirdPartySipCalling`, `webexCalling` and `none`."
},
"notes": {
"type": "string",
"example": "this is a note",
"description": "Notes associated to the workspace."
},
"hotdeskingStatus": {
"type": "string",
"enum": [
"on",
"off"
],
"description": "Hot desking status of the workspace.\n * `on` - Workspace supports hotdesking.\n * `off` - Workspace does not support hotdesking.\n"
},
"deviceHostedMeetings": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Set to `true` to enable or `false` to disable."
},
"siteUrl": {
"type": "string",
"example": "'example.webex.com'",
"description": "The Webex site for device hosting meetings."
}
},
"description": "To enable device hosted meetings, set a Webex `siteUrl` and the `enabled` flag to `true`."
},
"indoorNavigation": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "URL of a map locating the workspace. Passing `null` will remove the configuration."
}
},
"description": "Indoor navigation configuration."
}
}
},
"WorkspaceCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Workspace"
},
"description": "An array of workspace objects."
}
},
"example": {
"items": []
}
},
"CapabilityResponse": {
"type": "object",
"example": {
"capabilities": {
"occupancyDetection": {
"supported": true,
"configured": true
},
"presenceDetection": {
"supported": true,
"configured": true
},
"ambientNoise": {
"supported": true,
"configured": true
},
"soundLevel": {
"supported": true,
"configured": true
},
"temperature": {
"supported": true,
"configured": true
},
"airQuality": {
"supported": true,
"configured": true
},
"relativeHumidity": {
"supported": true,
"configured": true
}
}
},
"properties": {
"capabilities": {
"$ref": "#/components/schemas/CapabilityMap"
}
}
},
"CapabilityMap": {
"type": "object",
"description": "The map of workspace capabilities.",
"example": {
"occupancyDetection": {
"supported": true,
"configured": true
},
"presenceDetection": {
"supported": true,
"configured": true
},
"ambientNoise": {
"supported": true,
"configured": true
},
"soundLevel": {
"supported": true,
"configured": true
},
"temperature": {
"supported": true,
"configured": true
},
"airQuality": {
"supported": true,
"configured": true
},
"relativeHumidity": {
"supported": true,
"configured": true
}
},
"properties": {
"occupancyDetection": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
},
"presenceDetection": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
},
"ambientNoise": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
},
"soundLevel": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
},
"temperature": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
},
"airQuality": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
},
"relativeHumidity": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
}
}
},
"SupportAndConfiguredInfo": {
"type": "object",
"properties": {
"supported": {
"type": "boolean",
"example": true,
"description": "Is the workspace capability supported or not."
},
"configured": {
"type": "boolean",
"example": true,
"description": "Is the workspace capability configured or not."
}
},
"description": "Support and configured information for a workspace capability.",
"example": {
"supported": true,
"configured": true
}
},
"ListReport": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "'Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2ZhOA'",
"description": "A unique report id that corresponds to a billing report."
},
"billingStartDate": {
"type": "string",
"example": "2021-05-21",
"description": "Billing report startDate."
},
"billingEndDate": {
"type": "string",
"example": "2021-05-30",
"description": "Billing report endDate."
},
"status": {
"type": "string",
"enum": [
"IN_PROGRESS",
"COMPLETED",
"FAILED"
],
"description": "The status of the billing report\n * `IN_PROGRESS` - Report generation is in progress.\n * `COMPLETED` - Report generation is complete.\n * `FAILED` - Report generation failed.\n"
},
"type": {
"type": "string",
"enum": [
"USER",
"CUSTOMER",
"PARTNER"
],
"description": "Billing Report Type."
},
"category": {
"type": "string",
"example": "RECONCILIATION",
"default": "RECONCILIATION",
"enum": [
"RECONCILIATION",
"POINT_IN_TIME"
],
"description": "The category of the billing report."
}
}
},
"ReportError": {
"type": "object",
"properties": {
"code": {
"type": "number",
"example": 2024,
"description": "An error code that identifies the reason for the error."
},
"description": {
"type": "string",
"example": "Billing Report not found.",
"description": "A textual representation of the error code."
}
}
},
"ReportId": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "'Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2ZhOA'",
"description": "A unique report ID that corresponds to a billing report."
},
"billingStartDate": {
"type": "string",
"example": "2021-05-21",
"description": "Billing report startDate."
},
"billingEndDate": {
"type": "string",
"example": "2021-05-30",
"description": "Billing report endDate."
},
"type": {
"type": "string",
"enum": [
"USER",
"CUSTOMER",
"PARTNER"
],
"description": "Billing Report Type"
},
"category": {
"type": "string",
"example": "RECONCILIATION",
"enum": [
"RECONCILIATION",
"POINT_IN_TIME"
],
"description": "The category of the billing report."
}
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2ZhOA",
"billingStartDate": "2021-05-21",
"billingEndDate": "2021-05-30",
"type": "PARTNER",
"category": "RECONCILIATION"
}
},
"WholesaleBillingReportsListResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ListReport"
},
"description": "An array of report objects."
}
},
"example": {
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2ZhOA",
"billingStartDate": "2021-05-21",
"billingEndDate": "2021-05-30",
"type": "PARTNER",
"category": "RECONCILIATION",
"created": "2021-06-16T12:40:33.109Z",
"createdBy": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wYWNkMzg3NS00ZTEyLTRkNzctYjk4MS1lMzg5ZmQ4ODQ2YzA",
"status": "COMPLETED",
"tempDownloadURL": "https://billing-reports-int-us-east-1.webexcontent.com/sample.csv"
}
]
}
},
"WholesalePackagesCustomer": {
"type": "string",
"enum": [
"common_area_calling",
"webex_calling",
"webex_meetings",
"webex_suite",
"webex_voice",
"cx_essentials",
"webex_calling_standard",
"cisco_calling_plan",
"attendant_console",
"cx_premium_agent",
"cx_standard_agent",
"cx_voice_ports",
"cx_ai_assistant",
"webex_ai_agent"
],
"description": " * `common_area_calling` - Webex Common Area Calling Package.\n * `webex_calling` - Webex Calling Package.\n * `webex_meetings` - Webex Meetings Package.\n * `webex_suite` - Webex Suite Package.\n * `webex_voice` - Webex Voice Package.\n * `cx_essentials` - Customer Assist Package.\n * `webex_calling_standard` - Webex Calling Standard Package.\n * `cisco_calling_plan` - Cisco Calling Plan Package.\n * `attendant_console` - Attendant Console Package.\n * `cx_premium_agent` - Contact Center Premium Agent Package.\n * `cx_standard_agent` - Contact Center Standard Agent Package.\n * `cx_voice_ports` - Contact Center Voice Ports Package.\n * `cx_ai_assistant` - Contact Center AI Assistant Package.\n * `webex_ai_agent` - Webex AI Agent Package.\n"
},
"Address": {
"type": "object",
"properties": {
"addressLine1": {
"type": "string",
"example": "771 Alder Drive",
"description": "Address Line 1."
},
"addressLine2": {
"type": "string",
"example": "Cisco Site 5",
"description": "Address Line 2."
},
"city": {
"type": "string",
"example": "Milpitas",
"description": "Customer's city."
},
"stateOrProvince": {
"type": "string",
"example": "CA",
"description": "State or Province of the customer."
},
"zipOrPostalCode": {
"type": "string",
"example": "95035",
"description": "Postal/Zip code of the customer."
},
"country": {
"type": "string",
"example": "`US`:",
"description": "ISO2 country code of the customer, 2 characters. This attribute is used to determine the default Dial In number for the Webex Meeting Sites. Refer to the Address section of [help page](https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/cloudCollaboration/wholesale_rtm/wbxbw_b_wholesale-rtm-solution-guide/wbxbw_m_overview-of-webex-wholesale.html#Cisco_Reference.dita_7875bb3e-10c0-4214-8173-7845db31c7a6) for more information."
}
}
},
"Customer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "'Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4'",
"description": "A unique Cisco identifier for the customer. This value should be used for the `customerId` parameter in the Wholesale Customers and Wholesale Subscribers API."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"description": "The Organization ID of the enterprise on Cisco Webex, to be used when referencing this customer on other Cisco Webex APIs. Only presented when status is `provisioned`."
},
"externalId": {
"type": "string",
"example": "c1677a16-557a-4fb4-b48f-24adde57ec99",
"description": "External ID of the Customer."
},
"address": {
"$ref": "#/components/schemas/Address"
},
"status": {
"type": "string",
"enum": [
"provisioned",
"provisioned_with_errors",
"provisioning",
"updating",
"deleting",
"error",
"pending_rpl_review"
],
"description": "The provisioning status of the customer.\n * `provisioned` - Customer is fully provisioned on Cisco Webex.\n * `provisioned_with_errors` - Customer is provisioned with errors.\n * `provisioning` - Customer is provisioning.\n * `updating` - Customer is updating.\n * `deleting` - Customer is being deleted.\n * `error` - An error occurred provisioning the customer on Cisco Webex.\n * `pending_rpl_review` - The customer is pending a Denied Party List compliance check.\n"
},
"packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WholesalePackagesCustomer"
},
"description": "List of package names provisioned"
},
"resourceDetails": {
"$ref": "#/components/schemas/ResourceDetails"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
},
"description": "List of errors that occurred during that last attempt to provision/update this customer.\n\n *Note:*\n\n+ This list captures errors that occurred during *asynchronous or background* provisioning of the customer, *after* the API has been accepted and 202 response returned.\n\n+ Any errors that occur during initial API request validation will be captured directly in error response with appropriate HTTP status code."
}
}
},
"CustomerListResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Customer"
},
"description": "An array of Customer objects."
}
}
},
"CustomerProvisioningPrecheckResponse": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "success",
"description": "A textual representation of the Precheck response message containing the `infoCode` object in the case of a success response and the `errorCode` object in the case of failure."
},
"info": {
"type": "object",
"properties": {
"infoCode": {
"type": "number",
"example": 100,
"description": "Provisioning Precheck `infoCode`."
},
"description": {
"type": "string",
"example": "Provisioning Precheck validation successful.",
"description": "A textual description of the `infoCode`."
}
},
"description": "A list of `ProvisioningPreCheckResponseInfo` objects."
}
}
},
"Error": {
"type": "object",
"properties": {
"errorCode": {
"type": "number",
"example": 10022,
"description": "An error code that identifies the reason for the error."
},
"description": {
"type": "string",
"example": "The email is already associated with an existing user.",
"description": "A textual representation of the error code."
}
}
},
"Package": {
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/WholesalePackagesCustomer",
"description": "The Webex Wholesale Packages assigned to the customer."
},
"status": {
"type": "string",
"enum": [
"provisioned",
"provisioning",
"deleting",
"error"
],
"description": "The provisioning status of the a particular package.\n * `provisioned` - Customer is fully provisioned on Cisco Webex.\n * `provisioning` - Customer is provisioning.\n * `deleting` - Customer is being deleted.\n * `error` - An error occurred provisioning the customer on Cisco Webex.\n"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
},
"description": "List of warnings that occurred during that last attempt to provision/update this customer.\n\n *Note:*\n\n+ This list captures errors that occurred during *asynchronous or background* provisioning of the customer, *after* the API has been accepted and 202 response returned.\n\n+ Any errors that occur during initial API request validation will be captured directly in error response with appropriate HTTP status code."
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
},
"description": "List of errors that occurred during that last attempt to provision/update this customer.\n\n *Note:*\n\n+ This list captures errors that occurred during *asynchronous or background* provisioning of the customer, *after* the API has been accepted and 202 response returned.\n\n+ Any errors that occur during initial API request validation will be captured directly in error response with appropriate HTTP status code."
},
"licenseIds": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvYjdjNGRlZTgtODZmNi00YzAxLWJkYjMtMTM3MjM2ZWY3NGRmOlNMV0NBXzdmYTBkZjhjLTlmNTEtNGE1Zi05YzY4LTU1ODRlNWM2N2E0Yg"
},
"description": "List of licenseIds for the package."
}
}
},
"ResourceURL": {
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "\"https://webexapis.com/v1/wholesale/customers/Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4\"",
"description": "A URL which points to the [Get a Wholesale Customer](/docs/api/v1/wholesale-provisioning/get-a-wholesale-customer) endpoint for the provisioned customer."
}
}
},
"ResourceDetails": {
"type": "object",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Package"
}
}
}
},
"SubPartner": {
"type": "object",
"properties": {
"orgId": {
"type": "string",
"example": "'Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE'",
"description": "The Organization ID for the sub-partner."
},
"subscriptionId": {
"type": "string",
"example": "'Sub23452345'",
"description": "The Wholesale Subscription ID of the partner."
},
"provisioningState": {
"type": "string",
"enum": [
"active",
"suspended"
],
"description": "The provisioning status of the sub-partner.\n * `active` - Sub-partner can provision new customers and subscribers or update, delete existing ones.\n * `suspended` - Sub-partner cannot provision, update customers and subscribers but can delete existing ones.\n"
},
"created": {
"type": "string",
"example": "'2023",
"description": "02-16T14:10:18.855Z' (string) - The date and time the sub-partner was created."
},
"billingStartDate": {
"type": "string",
"example": "'2023",
"description": "02-22T13:43:41.117Z' (string) - The date and time from which new billing for the sub-partner started."
}
}
},
"SubPartnersListResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubPartner"
},
"description": "An array of `SubPartner` objects."
}
}
},
"WholesalePackagesSubscriber": {
"type": "string",
"enum": [
"webex_calling",
"webex_meetings",
"webex_suite",
"webex_voice",
"cx_essentials",
"webex_calling_standard",
"attendant_console",
"cx_premium_agent",
"cx_standard_agent"
],
"description": " * `webex_calling` - Calling Basic Package.\n * `webex_meetings` - Meetings Package.\n * `webex_suite` - Suite Package.\n * `webex_voice` - Voice Package.\n * `cx_essentials` - Customer Assist Package.\n * `webex_calling_standard` - Webex Calling Standard Package.\n * `attendant_console` - Attendant Console Package.\n * `cx_premium_agent` - Contact Center Premium Agent Package.\n * `cx_standard_agent` - Contact Center Standard Agent Package.\n"
},
"Subscriber": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "'Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk'",
"description": "A unique Cisco identifier for the subscriber."
},
"personId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"description": "The person id of the subscriber used in the /people API. Only presented when status is `provisioned`."
},
"email": {
"type": "string",
"example": "john.anderson@acme.com",
"description": "The email address of the subscriber."
},
"customerId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"description": "A unique identifier for the customer."
},
"externalCustomerId": {
"type": "string",
"example": "c1677a16-557a-4fb4-b48f-24adde57ec99",
"description": "External ID of the Wholesale customer."
},
"package": {
"type": "string",
"enum": [
"webex_calling",
"webex_meetings",
"webex_suite",
"webex_voice",
"cx_essentials",
"webex_calling_standard"
],
"description": "The Webex Wholesale Package assigned to the subscriber.\n * `webex_calling` - Calling Basic Package.\n * `webex_meetings` - Meetings Package.\n * `webex_suite` - Suite Package.\n * `webex_voice` - Voice Package.\n * `cx_essentials` - Customer Assist Package.\n * `webex_calling_standard` - Webex Calling Standard Package.\n"
},
"packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WholesalePackagesSubscriber"
},
"description": "The list of Webex Wholesale packages assigned to the subscriber."
},
"status": {
"type": "string",
"enum": [
"provisioned",
"pending_user_migration"
],
"description": "The provisioning status of the user.\n * `provisioned` - The subscriber is fully provisioned on Cisco Webex.\n * `pending_user_migration` - The subscriber user migration is pending.\n"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
},
"description": "List of errors that occurred during that last attempt to provision/update this subscriber.\n\n *Note:*\n\n+ This list captures errors that occurred during provisioning of the subscriber.\n\n+ Any errors that occur during initial API request validation will be captured directly in error response with appropriate HTTP status code."
},
"created": {
"type": "string",
"example": "2019-10-18T14:26:16.000Z",
"description": "The date and time the subscriber was provisioned."
},
"lastStatusChange": {
"type": "string",
"example": "2020-03-18T16:05:34.000Z",
"description": "The date and time the provisioning status of the subscriber last changed."
}
}
},
"SubscriberListResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Subscriber"
},
"description": "An array of Subscriber objects."
}
}
},
"SubscriberProvisioningPrecheckResponse": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "success",
"description": "A textual representation of the Precheck response message containing the `infoCode` object in the case of a success response and the `errorCode` object in the case of failure."
},
"info": {
"type": "object",
"properties": {
"infoCode": {
"type": "number",
"example": 100,
"description": "Provisioning Precheck `infoCode`."
},
"description": {
"type": "string",
"example": "Provisioning Precheck validation successful.",
"description": "A textual description of the `infoCode`."
}
},
"description": "A list of `ProvisioningPreCheckResponseInfo` objects."
}
}
}
},
"securitySchemes": {
"oauth2": {
"flows": {
"authorizationCode": {
"authorizationUrl": "/",
"scopes": {},
"tokenUrl": "/"
}
},
"type": "oauth2"
},
"bearer-key": {
"type": "http",
"description": "e.g. Bearer YOUR_AUTHORIZATION_TOKEN",
"scheme": "bearer",
"bearerFormat": "JWT"
},
"bearerAuth": {
"type": "http",
"description": "e.g. Bearer YOUR_AUTHORIZATION_TOKEN",
"scheme": "bearer",
"bearerFormat": "JWT"
}
},
"parameters": {},
"responses": {},
"requestBodies": {}
}
}