v1

latestOpenAPI 3.1.02026-07-24317911.4 MB
Voicemail Reminders

Create Voicemail Reminder

post/domains/{domain}/users/{user}/vmailnag

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com
userstring required

This is the main user extension for the user account. ~ can be used to mean "my account" which will extract the user from the token/key used for authentication.

Example:1000

Request body

voicemail-reminder-phonecall-enabled'yes' | 'no'
voicemail-reminder-phonecall-phonenumber-arrayinteger[]

Phone reminder numbers

voicemail-reminder-sms-enabled'yes' | 'no'
voicemail-reminder-sms-phonenumber-arrayinteger[]

SMS reminder numbers

voicemail-reminder-email-enabled'yes' | 'no'
voicemail-reminder-email-address-arraystring[]

Email reminder addresses

voicemail-reminder-interval-minutesinteger

Interval of reminders (minutes)

voicemail-reminder-last-sentinteger

Timestamp of last sent reminder

voicemail-reminder-control-serverstring

Current server managing the reminders for the user

Example request

{
  "voicemail-reminder-phonecall-phonenumber-array": [
    8585551234
  ],
  "voicemail-reminder-sms-phonenumber-array": [
    8585551234
  ],
  "voicemail-reminder-email-address-array": [
    "test@email.com"
  ]
}

Response

object required