REST API
Getting Started Basics
API Reference
Guides
API Changelog

Read Voicemail Settings for a Person

Retrieve 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, user, or read-only administrator auth token with a scope of spark-admin:people_read or a user auth token with spark:people_read scope can be used by a person to read their own settings.

GET/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.

Response Properties
enabled
boolean

Voicemail is enabled or disabled.

sendAllCalls
object

Settings for sending all calls to voicemail.

enabled
boolean

All calls will be sent to voicemail.

sendBusyCalls
object

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

enabled
boolean

Calls will be sent to voicemail when busy.

greeting
enum

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.

greetingUploaded
boolean

Indicates a custom greeting has been uploaded.

sendUnansweredCalls
object
enabled
boolean

Enables and disables sending on unanswered calls to voicemail.

greeting
enum

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.

greetingUploaded
boolean

Indicates a custom greeting has been uploaded

numberOfRings
number

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

systemMaxNumberOfRings
number

System-wide maximum number of rings allowed for numberOfRings setting.

notifications
object

Settings for notifications when there are any new voicemails.

enabled
boolean

Send of unanswered calls to voicemail is enabled or disabled.

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
object

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

enabled
boolean

Indicates enable or disabled state of giving caller option to tranfer to destination when 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
boolean

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
boolean

When true desktop phone will indicate there are new voicemails.

storageType
enum

Designates which type of voicemail message storage is used.

INTERNAL
string

For message access via phone or the Calling User Portal.

EXTERNAL
string

For sending all messages to the person's email.

externalEmail
string

External email address to which the new voicemail audio will be sent. A value for this field must be provided in the request if a storageType of EXTERNAL is given in the request.

faxMessage
object
enabled
boolean

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

phoneNumber
string

Designates phone number for fax. A value for this field must be provided in the request if faxMessage enabled field is given as true in the request.

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.
GET
/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.
https://webexapis.com/v1/people/Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI/features/voicemail?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
200 / OK
{
    "enabled": true,
    "sendAllCalls": {
            "enabled": true
    },
    "sendBusyCalls": {
            "enabled": false,
            "greeting": "DEFAULT",
            "greetingUploaded": false
    },
    "sendUnansweredCalls": {
            "enabled": false,
            "greeting": "DEFAULT",
            "greetingUploaded": true,
            "numberOfRings": 3,
            "systemMaxNumberOfRings": 20
    },
    "notifications": {
            "enabled": true,
            "destination": "julie@example.com"
    },
    "transferToNumber": {
            "enabled": false
    },
    "emailCopyOfMessage": {
            "enabled": false,
            "emailId": "julie@example.com"
    }
}