JSON API » messages » messages/forward

Forward voicemail or fax messages to another customer mailbox.

Input parameters

Requires authentication and the features, messages, or user role privileges.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
smailbox	String	Source mailbox.	Yes
sfolder	String	Source folder. Most commonly "INBOX".	Yes
dmailbox	String	Destination mailbox.	Yes
dfolder	String	Destination folder. Most commonly "INBOX".	Yes
messages	String	Message files to copy. Separate multiple with commas.	Yes
scustomer	Integer	ID of customer owning source mailbox.	No	Customer of authentication user.
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
201	Input passed validation: There is single destination mailbox. Only returned if validation=1.
204	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The source or destination mailbox does not exist.
405	The destination mailbox is ambiguous.
500	The destination mailbox is full.

Data returned

No data is returned.

Example:

http://enswitch.example.com/api/json/messages/forward/?auth_username=user;auth_password=password;smailbox=1234;sfolder=INBOX;dmailbox=1235;dfolder=INBOX;messages=msg0001,msg0002

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
4.2	Function added.