DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
What's NewOverviewDeveloper GuideSidebar API Quick StartSubmission Checklist for Embedded Apps
Design Guidelines
MessagingMeetingsDevicesSidebar
API Reference
BotsButtons and CardsIntegrationsBYODSService AppsService App GuestsService Apps G2GGuest IssuerWidgetsWebex ConnectLogin with WebexInstant ConnectInstant Connect Meeting LinksDeveloper SandboxBeta ProgramSubmit Your AppSupport PolicyFAQs
APIs
API Behavior ChangesPartners API GuideXML API DeprecationAccess the APIREST API BasicsCompliance
Webex APIs
Reference
Data Sources
Admin
OverviewAdmin APIsHybrid ServicesAuthentication
Guides
Hybrid ServicesWebhooksService Apps G2GReal-time File DLP BasicsProvisioning APIsBackground ImagesAudit Events Error Reference
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesMeeting QualitiesOrganization ContactsOrganizationsPartner ManagementPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSecurity Audit EventsSession TypesSettingsSpace ClassificationsTracking CodesWorkspace LocationsWorkspace Metrics
Webex Calling Beta
Overview
Guides
Integrations and AuthorizationMetadata and Samples
Webex Calling
OverviewSDKs and ToolsWhat's New
Guides
Integrations and AuthorizationProvisioning APIsMetadata and SamplesBackground Images
Reference
Call ControlsCall RoutingCalling Service SettingsClient Call SettingsConference ControlsConverged RecordingsDECT Devices SettingsDevice Call SettingsDevices
GETList Devices
GETGet Device Details
DELETEDelete a Device
PATCHModify Device Tags
POSTCreate a Device Activation Code
POSTCreate a Device by MAC Address
Emergency Services SettingsFeatures: Announcement PlaylistFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Customer Experience EssentialsFeatures: Hunt GroupFeatures: Paging GroupFeatures: Single Number ReachLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsNumbersPSTNPeopleRecording ReportReportsReports: Detailed Call HistorySend Activation EmailUser Call SettingsVirtual Line Call SettingsWorkspace Call SettingsWorkspaces
Webex for Broadworks
Overview
Guides
Integrations and AuthorizationDeveloper's Guide
Reference
BroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks Workspaces
Webex for Wholesale
Overview
Guides
Developer's Guide
Reference
Wholesale Billing ReportsWholesale Provisioning
Webex for UCM
Guides
Integrations and Authorization
Reference
UCM Profile
Contact Center
Overview
Reference
Data Sources
Customer Journey Data
Overview
Guides
Getting StartedFAQ
Devices
Overview
Guides
Devices
Reference
Device Call SettingsDevice ConfigurationsDevices
GETList Devices
GETGet Device Details
DELETEDelete a Device
PATCHModify Device Tags
POSTCreate a Device Activation Code
POSTCreate a Device by MAC Address
Workspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Directory Services
Reference
Identity Organization
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksService Apps G2GWebinar GuideMeeting Resource Guide
Reference
Meeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportPeopleRecording ReportRecordingsSession TypesTracking CodesVideo MeshWebhooks
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooksService Apps G2GButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
SCIM 2
Overview
Reference
SCIM 2 BulkSCIM 2 GroupsSCIM 2 Users
Webex Assistant Skills
Overview
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
Workspace Integrations
OverviewTechnical DetailsControl Hub Features
Webex Status API
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks WorkspacesCall ControlsCall RoutingCalling Service SettingsClient Call SettingsConference ControlsConverged RecordingsDECT Devices SettingsData SourcesDevice Call SettingsDevice ConfigurationsDevices
GETList Devices
GETGet Device Details
DELETEDelete a Device
PATCHModify Device Tags
POSTCreate a Device Activation Code
POSTCreate a Device by MAC Address
Emergency Services SettingsEventsFeatures: Announcement PlaylistFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Customer Experience EssentialsFeatures: Hunt GroupFeatures: Paging GroupFeatures: Single Number ReachGroupsGuests ManagementHistorical AnalyticsHybrid ClustersHybrid ConnectorsIdentity OrganizationLicensesLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesNumbersOrganization ContactsOrganizationsPSTNPartner ManagementPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsReports: Detailed Call HistoryResource Group MembershipsResource GroupsRolesRoom TabsRoomsSCIM 2 BulkSCIM 2 GroupsSCIM 2 UsersSecurity Audit EventsSend Activation EmailSession TypesSettingsSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesUCM ProfileUser Call SettingsVideo MeshVirtual Line Call SettingsWebhooksWholesale Billing ReportsWholesale ProvisioningWorkspace Call SettingsWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
Space Meetings Migration
Calling
Introduction
Platform
Web
IntroductionQuickstart
Basics
AuthorizationCore ConceptsCalls
Advanced Features
Call SettingsContactsSupplementary ServicesVoicemailBackground Noise Reduction
Kitchen Sink
Meetings
Introduction
Platform
Web
IntroductionQuickstart
Basics
AuthorizationJoin a MeetingMigration To Improved MeetingsPasswords & CaptchasUnified Space Meetings
Advanced Features
Advanced ControlsDialing In and OutStreams & EffectsVideo Resolution
Multistream
Multistream Comprehensive GuideMultistream Quickstart
Migrating SDK V2 to V3
iOSAndroidBrowserClick to Call
Developer CommunityCertifications

Create a Device by MAC Address

Create a phone by its MAC address in a specific workspace or for a person.

Specify the mac, model and either workspaceId or personId.

  • You can get the model from the supported devices API.

  • Either workspaceId or personId should be provided. If both are supplied, the request will be invalid.

  • The password field is only required for third party devices. You can obtain the required third party phone configuration from here.

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
Query Parameters
orgId
string

The organization associated with the device. If left empty, the organization associated with the caller will be used.

Body Parameters
mac
stringrequired

The MAC address of the device being created.

model
stringrequired

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.

workspaceId
string

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

personId
string

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

password
string

SIP password to be configured for the phone, only required with third party devices.

Response Properties
id
string

A unique identifier for the device.

displayName
string

A friendly name for the device.

placeId
string

The placeId field has been deprecated. Please use workspaceId instead.

workspaceId
string

The workspace associated with the device.

personId
string

The person associated with the device.

orgId
string

The organization associated with the device.

capabilities
array[xapi]

The capabilities of the device.

permissions
array[xapi]

The permissions the user has for this device. For example, xapi means this user is entitled to using the xapi against this device.

connectionStatus
Device Connection Status

The connection status of the device.

connected
string
disconnected
string
connected_with_issues
string
offline_expired
string
activating
string
unknown
string
product
string

The product name. A display friendly version of the device's model.

type
string

The product type.

tags
array[string]

Tags assigned to the device.

ip
string

The current IP address of the device.

activeInterface
Network Connectivity Type

The current network connectivty for the device.

wired
string
mac
string

The unique address for the network adapter.

primarySipUrl
string

The primary SIP address to dial this device.

sipUrls
array[string]

All SIP addresses to dial this device.

serial
string

Serial number for the device.

software
string

The operating system name data and version tag.

upgradeChannel
string

The upgrade channel the device is assigned to.

created
string

The date and time that the device was registered, in ISO8601 format.

locationId
string

The location associated with the device.

workspaceLocationId
string

The workspace location associated with the device. Deprecated, prefer locationId.

errorCodes
array[string]

Error codes coming from the device.

firstSeen
string

Timestamp of the first time device sent a status post.

lastSeen
string

Timestamp of the last time device sent a status post.

managedBy
Managed By

Entity managing the device configuration.

CISCO
string
CUSTOMER
string
PARTNER
string
devicePlatform
Device Platform

The device platform.

cisco
string
microsoftTeamsRoom
string
Response Codes

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

CodeStatusDescription
200OKSuccessful request with body content.
201CreatedThe request has succeeded and has led to the creation of a resource.
202AcceptedThe request has been accepted for processing.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe 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.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
  • Try it
  • Example
POST
/v1/devices{?orgId}
Log in to try the API.
Header
Query Parameters
  • The organization associated with the device. If left empty, the organization associated with the caller will be used.
Body
  • The MAC address of the device being created.
  • 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.
  • The ID of the workspace where the device will be created.
  • The ID of the person who will own the device once created.
  • SIP password to be configured for the phone, only required with third party devices.
  • Request
  • Response
https://webexapis.com/v1/devices?orgId=Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi9mN2I3MzYwYy1lMDcxLTQwN2EtYTU1Ny04NDI4YmIyMjhlODQ
{
    "mac":"D82E3EEF4E5C",
    "model":"DMS Cisco 8865",
    "workspaceId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU"
}
200 / OK
{
  "id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3",
  "displayName": "SFO12-3-PanHandle",
  "placeId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
  "workspaceId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
  "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
  "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
  "capabilities": [
    {}
  ],
  "permissions": [
    {}
  ],
  "connectionStatus": "connected",
  "product": "Cisco Webex DX80",
  "type": "roomdesk",
  "tags": [
    "First Tag",
    "Second Tag"
  ],
  "ip": "100.110.120.130",
  "activeInterface": "wired",
  "mac": "11:22:33:44:AA:FF",
  "primarySipUrl": "sample_device@sample_workspacename.orgname.org",
  "sipUrls": [
    "sample_device@sample_workspacename.orgname.org",
    "another_device@sample_workspacename.orgname.org"
  ],
  "serial": "FOC1923NVVN",
  "software": "RoomOS 2018-06-01 608dcdbb6e1",
  "upgradeChannel": "beta",
  "created": "2016-04-21T17:00:00.000Z",
  "locationId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
  "workspaceLocationId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
  "errorCodes": [
    "sipprofileregistration"
  ],
  "firstSeen": "2021-02-24T09:08:38.822Z",
  "lastSeen": "2023-08-15T14:04:00.444Z",
  "managedBy": "CISCO",
  "devicePlatform": "cisco"
}

Connect

Support

Developer Community

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2024 Cisco and/or its affiliates. All rights reserved.