APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
Calling
Contact Center
Devices
Meetings
Messaging
Webex Assistant Skills
FedRAMP
Full API Reference
API Changelog

Trigger Directory Sync for a User

This API will allow a Partner Admin to trigger a directory sync for an external user (real or virtual user) on Broadworks enterprise with Cisco Webex.

POST/v1/broadworks/enterprises/{id}/broadworksDirectorySync/externalUser
URI Parameters
id
stringrequired

A unique identifier for the enterprise in question.

Body Parameters
userId
string

The user ID of the Broadworks user to be synced (A non-webex user).

Response Properties
userResponse
object

User Directory sync response

userId
string

The UserID of the user on Broadworks (A non-webex user).

firstName
string

First Name of the user on Broadworks.

lastName
string

Last Name of the user on Broadworks.

extension
string

Extension of the user on Broadworks.

number
string

Phone number of the user on Broadworks.

mobile
string

Mobile number of the user on Broadworks.

status
enum

The Status of the operation being performed.

ADD
string

The external user is added in this sync

UPDATE
string

The external user is updated in this sync

DELETE
string

The external user is deleted in this sync

NO_OPERATION
string

No changes made on the external user in this sync

Response Codes

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

CodeStatusDescription
200OKSuccessful request with body content.
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.
POST
/v1/broadworks/enterprises//broadworksDirectorySync/externalUser
Log in to try the API.
Header
Body
  • The user ID of the Broadworks user to be synced (A non-webex user).
https://webexapis.com/v1/broadworks/enterprises/Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk/broadworksDirectorySync/externalUser
{
  "userId": "john_anderson@acme.com"
}
200 / OK
{
  "userResponse": {
    "userId": "john.anderson@acme.com",
    "firstName": "John",
    "lastName": "Anderson",
    "extension": "4653",
    "number": "+35391884653",
    "mobile": "+188-(2323)-(343)"
  },
  "status": "ADD"
}