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

List Messages

Get the list of all voicemail messages for the user.

GET/v1/telephony/voiceMessages
Response Properties
items
array[VoiceMessageDetails]
id
string

The message identifier of the voicemail message.

duration
number

The duration (in seconds) of the voicemail message. Duration is not present for a Fax message.

callingParty
VoiceMailPartyInformation

The calling party's details. For example, if user A calls user B and leaves a voicemail message, then A is the calling party.

name
string

The party's name. Only present when the name is available and privacy is not enabled.

number
string

The party's number. Only present when the number is available and privacy is not enabled. The number can be digits or a URI. Some examples for number include: 1234, 2223334444, +12223334444, *73, user@company.domain

personId
string

The party's person ID. Only present when the person ID is available and privacy is not enabled.

placeId
string

The party's place ID. Only present when the place ID is available and privacy is not enabled.

privacyEnabled
boolean

Indicates whether privacy is enabled for the name, number and personId/placeId.

urgent
boolean

True if the voicemail message is urgent.

confidential
boolean

True if the voicemail message is confidential.

read
boolean

True if the voicemail message has been read.

faxPageCount
number

Number of pages for the fax. Only set for a Fax.

created
string

The date and time the voicemail message was created.

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/telephony/voiceMessages
Log in to try the API.
Header
200 / OK
{
  "items": [
    {
      "id": "Y2lzY29zcGFyazovL3VzL01FU1NBR0UvNmQ0MTgyMTItZjUwNi00Yzk4LTk5MTItNmI1MmE1ZmU2ODgx",
      "duration": 38,
      "callingParty": {
        "name": "John Smith",
        "number": "+12223334444",
        "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9hMTlkODJhMi00ZTY5LTU5YWEtOWYyZi1iY2E2MzEwMTNhNjg=",
        "placeId": "Y2lzY29zcGFyazovL3VzL1BMQUNFL2ExOWQ3MWEyLTRlOTItOTFhYi05ZjJmLWJjYTEzNTAxM2ExNA==",
        "privacyEnabled": false
      },
      "urgent": false,
      "confidential": false,
      "read": true,
      "faxPageCount": 2,
      "created": "2021-11-14T17:00:00.000Z"
    }
  ]
}