Create an api
Create a Webex api.
At least one of the following body parameters is required to create a Webex api: apiName, method.
Developer can set api as test by specifying test parameter as true.
Query Parameters
set api as test in the response.
Body Parameters
The email addresses of the person. Only one email address is allowed per person.
Phone numbers for the person.
The type of phone number.
The phone number.
The extension of the person.
Method of the api.
The full name of the api.
method of api
The first name of the person.
The last name of the person.
The URL to the person's avatar in PNG format.
The ID of the organization to which this person belongs.
An array of role strings representing the roles to which this person belongs.
An array of license strings allocated to this person.
Response Properties
A unique identifier for the webex api.
The email addresses of the person who created the api.
Phone numbers for the person who created the api.
The type of phone number.
The phone number.
The full name of the Webex api. If no nickname is configured for the person, this field will not be present.
The first name of the person who created the api.
The last name of the person who created the api.
The URL to the person's avatar in PNG format.
An array of license strings allocated to this person.
The date and time the api was created.
The date and time the api was last changed.
The time zone of the api if configured. If no timezone is configured on the account, this field will not be present
The current presence status of the api. This will only be returned for api within your organization or an organization you manage. Presence information will not be shown if the api has disabled status sharing.
api is running
api is stopped
api is in maintenance
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. |
| 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
Query Parameters
- set api as test in the response.
Body
- The email addresses of the person. Only one email address is allowed per person.
- Phone numbers for the person.
- The extension of the person.
- Method of the api.
- The full name of the api.
- method of api
- The first name of the person.
- The last name of the person.
- The URL to the person's avatar in PNG format.
- The ID of the organization to which this person belongs.
- An array of role strings representing the roles to which this person belongs.
- An array of license strings allocated to this person.
{
"emails": [
"john.andersen@example.com"
],
"phoneNumbers": [
{
"type": "work",
"value": "408 526 7209"
}
],
"extension": "133",
"apiName": "People",
"method": "GET",
"firstName": "John",
"lastName": "Andersen",
"avatar": "https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"roles": [
"Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
],
"licenses": [
"Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
]
}{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"emails": [
"john.andersen@example.com"
],
"phoneNumbers": [
{
"type": "work",
"value": "+1 408 526 7209"
}
],
"apiName": "People",
"firstName": "John",
"lastName": "Andersen",
"avatar": "https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600",
"licenses": [
"Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
],
"created": "2015-10-18T14:26:16.000Z",
"lastModified": "2015-10-18T14:26:16.000Z",
"timezone": "America/Denver",
"status": "active"
}