Voicemail

List Voicemail

Get a list of voicemail messages for an account

get/v4/accounts/{voip_id}/voicemail

Request

  • Base URL: https://api.phone.com
  • URL: https://api.phone.com/v4/accounts/{voip_id}/voicemail
  • Auth: HTTP bearer

Path parameters

voip_idinteger required

Query parameters

offsetinteger

The number of items to skip before starting to collect the result set

limitinteger

The number of items to return

sort[id]'asc' | 'desc'

Sort response

filters[is_new]string

True when Voicemail is new; False when Voicemail has been read

filters[from]string

Caller ID filter, the E.164 phone number to send the Voicemail FROM. Note: you must encode the + as %2B

filters[to]string

Callee ID filter, the E.164 phone number to send the Voicemail TO. Note you must encode the + as %2B

filters[duration]string

Voicemail duration

filters[created_at]string

Date string representing the UTC time that Voicemail was created. Expected value is UNIX timestamp with operator like "gt" (greater than), "gte" (greater than or equals), "lt" (lesser than), "lte" (lesser than or equals). Example: "gt:1597778180".

filters[updated_at]string

Date string representing the UTC time that Voicemail was updated. Expected value is UNIX timestamp with operator like "gt" (greater than), "gte" (greater than or equals), "lt" (lesser than), "lte" (lesser than or equals). Example: "gt:1597778180".

filters[extension]string

Extension id where Voicemail is stored

filters[deleted]string

only=deleted Voicemail; ignore=existing Voicemail; with=both deleted and existing Voicemail

mode'brief' | 'full'

Defines mode of the data output (brief or full)

Response

OK

filtersobject
sortobject
totalinteger
limitinteger
offsetinteger
itemsobject[]

Changes

No operation changes recorded.