Test Environment. You are currently using the Webex for Developers test environment. Apps created here will not be available for use with Webex Teams. Please visit Webex for Developers to manage your apps.
REST API
Getting Started Basics
Guides
API Reference
API Changelog

Configure Voicemail Settings for a Person

Configure a person's Voicemail Settings

The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. Voicemail audio is sent in Waveform Audio File Format, .wav, format.

Optionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files.

This API requires a full or user administrator auth token with the spark-admin:people_write scope or a user auth token with spark:people_write scope can be used by a person to update their own settings.

PUT/v1/people/{personId}/features/voicemail
URI Parameters
personId
stringrequired

Unique identifier for the person.

Query Parameters
orgId
string

Person is in this organization. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as token used to access API.

Body Parameters
enabled
boolean

Voicemail is enabled or disabled.

sendAllCalls
object

Settings for sending all calls to voicemail.

enabled
string

All calls will be sent to voicemail.

sendBusyCalls
object

Settings for sending calls to voicemail when the line is busy.

enabled
string

Calls will be sent to voicemail when busy.

greeting
string

DEFAULT indicates the default greeting will be played. CUSTOM indicates a custom .wav file will be played.

DEFAULT
string

The default greeting will be played.

CUSTOM
string

Designates that a custom .wav file will be played.

sendUnansweredCalls
object
enabled
string

Unanswered call sending to voicemail is enabled or disabled.

greeting
string

DEFAULT indicates the default greeting will be played. CUSTOM indicates a custom .wav file will be played.

DEFAULT
string

The default greeting will be played.

CUSTOM
string

Designates that a custom .wav file will be played.

numberOfRings
string

Number of rings before unanswered call will be sent to voicemail.

notifications
objectrequired

Settings for notifications when there are any new voicemails.

enabled
string

Notifications for voicemails will be sent.

destination
string

Email address to which the notification will be sent. For text messages, use an email to text message gateway like 2025551212@txt.att.net.

transferToNumber
objectrequired

Settings for voicemail caller to to transfer to a different number by pressing zero (0).

enabled
string

Enable or disable voicemail caller transfer to a destination by pressing zero (0).

destination
string

Number voicemail caller will be transferred to when they press zero (0).

emailCopyOfMessage
object

Settings for sending copy of new voicemail message audio via email.

enabled
string

When true copy of new voicemail message audio will be sent to designated email.

emailId
string

Email address to which the new voicemail audio will be sent.

messageStorage
object
mwiEnabled
string

When true desktop phone will indicate there are new voicemails.

storageType
string

Designates which type of voicemail message storage is used.

INTERNAL
string

Internal mailbox storage has the following limitations: Single message limit of 10 minutes and total mailbox limit of 100 minutes."

EXTERNAL
string

If external mailbox is selected, all messages will be sent to the email address entered. Messages will not be accessible via phone, clients, or the end user's calling portal.

externalEmail
string

External email address to which the new voicemail audio will be sent.

faxMessage
object
enabled
string

When true fax messages for new voicemails will be sent to the designated number.

phoneNumber
string

Designates phone number for fax.

extension
string

Designates optional extension for fax.

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.
PUT
/v1/people//features/voicemail{?orgId}
Log in to try the API.
Header
Query Parameters
  • Person is in this organization. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as token used to access API.
Body
  • Voicemail is enabled or disabled.
  • Settings for sending all calls to voicemail.
  • Settings for sending calls to voicemail when the line is busy.
  • Settings for notifications when there are any new voicemails.
  • Settings for voicemail caller to to transfer to a different number by pressing zero (0).
  • Settings for sending copy of new voicemail message audio via email.
https://webexapis.com/v1/people/Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI/features/voicemail?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
{
    "enabled": true,
    "notifications": {
            "enabled": true,
            "destination": "julie@example.com"
    },
    "sendAllCalls": {
            "enabled": true
    },
    "sendBusyCalls": {
            "enabled": false,
            "greeting": "DEFAULT"
    },
    "sendUnansweredCalls": {
            "enabled": false,
            "greeting": "CUSTOM",
            "numberOfRings": 3
    },
    "transferToNumber": {
            "enabled": false
    },
    "emailCopyOfMessage": {
            "enabled": false,
            "emailId": "julie@example.com"
    }
}
204 / No Content