APIs
Getting StartedREST API BasicsComplianceWebhooksAPI Changelog
Admin
Calling
Contact Center
Devices
imiconnect
Meetings
Messaging
Webex Assistant Skills
Full API Reference

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.

POST/v1/webex/api
Query Parameters
testing
boolean

set api as test in the response.

Default: false
Body Parameters
emails
array[string]required

The email addresses of the person. Only one email address is allowed per person.

Possible values: john.andersen@example.com
phoneNumbers
array[object]

Phone numbers for the person.

type
enum

The type of phone number.

Possible values: work
value
string

The phone number.

Possible values: 408 526 7209
extension
string

The extension of the person.

method
string

Method of the api.

apiName
string

The full name of the api.

method
string

method of api

firstName
string

The first name of the person.

lastName
string

The last name of the person.

avatar
string

The URL to the person's avatar in PNG format.

orgId
string

The ID of the organization to which this person belongs.

roles
array[string]

An array of role strings representing the roles to which this person belongs.

Possible values: Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh, Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi
licenses
array[string]

An array of license strings allocated to this person.

Possible values: Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh, Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi
Response Properties
id
string

A unique identifier for the webex api.

emails
array[string]

The email addresses of the person who created the api.

phoneNumbers
array[object]

Phone numbers for the person who created the api.

type
enum

The type of phone number.

Possible values: work, mobile, fax
value
string

The phone number.

Possible values: +1 408 526 7209
apiName
string

The full name of the Webex api. If no nickname is configured for the person, this field will not be present.

firstName
string

The first name of the person who created the api.

lastName
string

The last name of the person who created the api.

avatar
string

The URL to the person's avatar in PNG format.

licenses
array[string]

An array of license strings allocated to this person.

created
string

The date and time the api was created.

lastModified
string

The date and time the api was last changed.

timezone
string

The time zone of the api if configured. If no timezone is configured on the account, this field will not be present

status
enum

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.

active
string

api is running

inactive
string

api is stopped

pending
string

api is in maintenance

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/webex/api{?testing}
Log in to try the API.
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.
https://webexapis.com/v1/webex/api?testing=true
{
  "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"
  ]
}
200 / OK
{
  "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"
}