VOICEMAIL FUNCTIONS
The following table explains the additional parameters needed by the Voicemail Functions and provides an example of their output when status is 'success'.
| createVoicemail | |
| Parameters |
digits => [Required] Digits used to create the voicemail (Example: 01)
Minimum 1 digit, maximum 10 digits
name => [Required] Name for the Mailbox
password => [Required] Password for the Mailbox
skip_password => [Required] True if Skipping Password (Boolean: 1/0)
email => Client's e-mail address for receiving Messages
attach_message => [Required] Yes for Attaching WAV files to Message (Values: 'yes'/'no')
delete_message => [Required] Yes for Deleting Messages (Values: 'yes'/'no')
say_time => [Required] Yes for Saying Time Stamp (Values: 'yes'/'no')
timezone => [Required] Time Zone for Mailbox (Values from getTimeZones)
say_callerid => [Required] Yes for Saying the Caller ID (Values: 'yes'/'no')
play_instructions => [Required] Code for Play Instructions Setting (Values from getPlayInstructions)
language => [Required] Code for Language (Values from getLanguages)
email_attachment_format => Code for Email Attachment format (Values from getVoicemailAttachmentFormats)
unavailable_message_recording => Recording for the Unavailable Message (values from getRecordings)
|
| Output |
Array
(
[status] => success
)
|
| delMessages | |
| Parameters |
mailbox => [Required] ID for a specific Mailbox (Example: 1001)
folder => Name for specific Folder
(Required if message id is passed, Example: 'INBOX', values from: getVoicemailFolders)
message_num => ID for specific Voicemail Message (Required if folder is passed, Example: 1)
|
| Output |
Array
(
[status] => success
)
|
| delVoicemail | |
| Parameters |
mailbox => [Required] ID for a specific Mailbox (Example: 1001) |
| Output |
Array
(
[status] => success
)
|
| getPlayInstructions | |
| Parameters |
play_instructions => Code for a specific Play Instructions setting (Example: 'u') |
| Output |
Array
(
[status] => success
[play_instructions] => Array
(
[0] => Array
(
[value] => u
[description] => Yes
)
)
)
|
| getTimezones | |
| Parameters |
timezone => Code for a specific Time Zone (Example: 'America/Buenos_Aires') |
| Output |
Array
(
[status] => success
[timezones] => Array
(
[0] => Array
(
[value] => America/Buenos_Aires
[description] => America/Buenos Aires
)
)
)
|
| getVoicemails | |
| Parameters |
mailbox => ID for specific Mailbox (Example: 1001) |
| Output |
Array
(
[status] => success
[voicemails] => Array
(
[0] => Array
(
[mailbox] => 1001
[name] => VoIP
[password] => 1234
[skip_password] => 1
[email] => john.doe@my-domain.com
[attach_message] => yes
[delete_message] => no
[say_time] => yes
[timezone] => America/Chicago
[say_callerid] => yes
[play_instructions] => su
[language] => en
[email_attachment_format] => wav49
[unavailable_message_recording]=> 19183
[new] => 3
[urgent] => 2
)
)
)
|
| getVoicemailFolders | |
| Parameters |
folder => Folder Name (Example: 'INBOX') |
| Output |
Array
(
[status] => success
[folders] => Array
(
[0] => Array
(
[value] => INBOX
[description] => INBOX
)
)
)
|
| getVoicemailMessageFile | |
| Parameters |
mailbox => [required] ID for specific Mailbox (Example: 1001)
folder => [required] Name for specific Folder
(Example: 'INBOX', values from: getVoicemailFolders)
message_num=> [required] ID for specific Voicemail Message (Example: 1)
|
| Output |
Array
(
[status] => success
[message] => Array
(
[0] => Array
(
[mailbox] => 1001
[folder] => INBOX
[message_num] => 1
[data] => UklGRqTEAQBXQVZFZm10IBAAAAABAAEAQB8AAIA+AAACABAAZGF0YYDEA....
)
)
)
|
| getVoicemailMessages | |
| Parameters |
mailbox => [Required] ID for specific Mailbox (Example: 1001)
folder => Name for specific Folder
(Example: 'INBOX', values from: getVoicemailFolders)
date_from => Start Date for Filtering Voicemail Messages (Example: '2016-01-30')
date_to => End Date for Filtering Voicemail Messages (Example: '2016-01-30')
|
| Output |
Array
(
[status] => success
[messages] => Array
(
[0] => Array
(
[mailbox] => 1001
[folder] => INBOX
[message_num] => 1
[date] => 2016-01-30
[callerid] => 5551234567
[duration] => 00:00:06
[urgent] => yes
[listened] => no
)
)
)
|
| markListenedVoicemailMessage | |
| Parameters |
mailbox => [required] ID for specific Mailbox (Example: 1001)
folder => [required] Name for specific Folder
(Example: 'INBOX', values from: getVoicemailFolders)
message_num => [required] ID for specific Voicemail Message (Example: 1)
listened => [required] Code for mark voicemail as listened or not-listened (Values: 'yes'/'no')
|
| Output |
Array
(
[status] => success
)
|
| markUrgentVoicemailMessage | |
| Parameters |
mailbox => [required] ID for specific Mailbox (Example: 1001)
folder => [required] Name for specific Folder (Example: 'INBOX', values from: getVoicemailFolders)
message_num => [required] ID for specific Voicemail Message (Example: 1)
urgent => [required] Code for mark voicemail as urgent or not-urgent (Values: 'yes'/'no')
|
| Output |
Array
(
[status] => success
)
|
| moveFolderVoicemailMessage | |
| Parameters |
mailbox => [required] ID for specific Mailbox (Example: 1001)
folder => [required] Name for specific Folder
(Example: 'INBOX', values from: getVoicemailFolders)
message_num => [required] ID for specific Voicemail Message (Example: 1)
new_folder => [required] Destination Folder (Example: 'Urgent', values from: getVoicemailFolders)
|
| Output |
Array
(
[status] => success
)
|
| sendVoicemailEmail | |
| Parameters |
mailbox => [required] ID for specific Mailbox (Example: 1001)
folder => [required] Name for specific Folder
(Example: 'INBOX', values from: getVoicemailFolders)
message_num => [required] ID for specific Voicemail Message (Example: 1)
email_address=> [required] Destination Email address (Example: john.doe@my-domain.com)
|
| Output |
Array
(
[status] => success
)
|
| setVoicemail | |
| Parameters |
mailbox => [Required] ID for a specific Mailbox (Example: 1001)
name => [Required] Name for the Mailbox
password => [Required] Password for the Mailbox
skip_password => [Required] True if Skipping Password (Boolean: 1/0)
email => Client's e-mail address for receiving Messages
attach_message => [Required] Yes for Attaching WAV files to Message (Values: 'yes'/'no')
delete_message => [Required] Yes for Deleting Messages (Values: 'yes'/'no')
say_time => [Required] Yes for Saying Time Stamp (Values: 'yes'/'no')
timezone => [Required] Time Zone for Mailbox (Values from getTimeZones)
say_callerid => [Required] Yes for Saying the Caller ID (Values: 'yes'/'no')
play_instructions => [Required] Code for Play Instructions Setting (Values from getPlayInstructions)
language => [Required] Code for Language (Values from getLanguages)
email_attachment_format => Code for Email Attachment format (Values from getVoicemailAttachmentFormats)
unavailable_message_recording => Recording for the Unavailable Message (values from getRecordings)
|
| Output |
Array
(
[status] => success
)
|
