Trigger Directory Sync for a User
This API lets a Partner Admin trigger a directory sync for an external user (real or virtual user) on Broadworks enterprise with Webex.
URI Parameters
A unique identifier for the enterprise in question.
Body Parameters
The user ID of the Broadworks user to be synced (A non-webex user).
Response Properties
User Directory sync response
The UserID of the user on Broadworks (A non-webex user).
First name of the user on Broadworks.
Last name of the user on Broadworks.
Extension of the user on Broadworks.
Phone number of the user on Broadworks.
Mobile number of the user on Broadworks.
The Status of the operation being performed.
The external user is added in this sync
The external user is updated in this sync
The external user is deleted in this sync
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:
| 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. |
Header
Body
- The user ID of the Broadworks user to be synced (A non-webex user).
{
"userId": "john_anderson@acme.com"
}{
"userResponse": {
"userId": "john.anderson@acme.com",
"firstName": "John",
"lastName": "Anderson",
"extension": "4653",
"number": "+35391884653",
"mobile": "+188-(2323)-(343)"
},
"status": "ADD"
}