Devices - Create a Device Activation Code

Create a Device Activation Code

Generate an activation code for a device in a specific workspace by workspaceId or for a person by personId. This requires an auth token with the spark-admin:devices_write scope, and either identity:placeonetimepassword_create (allows creating activation codes for workspaces only) or identity:one_time_password (allows creating activation codes for workspaces or persons).

Adding a device to a workspace with calling type none or thirdPartySipCalling will reset the workspace calling type to freeCalling.
Either workspaceId or personId should be provided. If both are supplied, the request will be invalid.
If no model is supplied, the code returned will only be accepted on RoomOS devices.
If your device is a phone, you must provide the model as a field. You can get the model from the supported devices API.

Adding a device to a person with a Webex Calling Standard license will disable Webex Calling across their Webex mobile, tablet, desktop, and browser applications.

POST/v1/devices/activationCode

Query Parameters

orgId

string

The organization associated with the activation code generated. If left empty, the organization associated with the caller will be used.

Body Parameters

workspaceId

string

The ID of the workspace where the device will be activated.

personId

string

The ID of the person who will own the device once activated.

model

string

The model of the device being created. The corresponding device model display name sometimes called the product name, can also be used to specify the model.

Response Properties

code

string

The activation code.

expiryTime

string

The date and time the activation code expires.

Response Codes

The list below describes the common success and error responses you should expect from the API:

Code	Status	Description
200	OK	Successful request with body content.
201	Created	The request has succeeded and has led to the creation of a resource.
202	Accepted	The request has been accepted for processing.
204	No Content	Successful request without body content.
400	Bad Request	The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401	Unauthorized	Authentication credentials were missing or incorrect.
403	Forbidden	The request is understood, but it has been refused or access is not allowed.
404	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	Method Not Allowed	The request was made to a resource using an HTTP request method that is not supported.
409	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	Gone	The requested resource is no longer available.
415	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	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	Precondition Required	File(s) cannot be scanned for malware and need to be force downloaded.
429	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	Internal Server Error	Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502	Bad Gateway	The server received an invalid response from an upstream server while processing the request. Try again later.
503	Service Unavailable	Server is overloaded with requests. Try again later.
504	Gateway Timeout	An upstream server failed to respond on time. If your query uses `max` parameter, please try to reduce it.

POST

/v1/devices/activationCode{?orgId}

Header

Content-Type
Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

orgId
string
The organization associated with the activation code generated. If left empty, the organization associated with the caller will be used.

Body

workspaceId
string
The ID of the workspace where the device will be activated.
personId
string
The ID of the person who will own the device once activated.
model
string
The model of the device being created. The corresponding device model display name sometimes called the product name, can also be used to specify the model.

https://webexapis.com/v1/devices/activationCode?orgId=Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi9mN2I3MzYwYy1lMDcxLTQwN2EtYTU1Ny04NDI4YmIyMjhlODQ

{
    "workspaceId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
    "model": "DMS Cisco 8865"
}

200 / OK

{
  "code": "5414011256173816",
  "expiryTime": "2017-11-16T23:38:03.215Z"
}