api:mailbox:forward
Table of Contents
API : Mailbox Forward
Introduction
This request will forward a mailbox message from the mailbox 'IN', to an e-mail or fax recipient.
Request
| URL | https://api.telecomx.dk/mailbox/MESSAGE_ID/forward | ||
|---|---|---|---|
| Method | GET | ||
| Access level | RESELLER_ADMIN with PORTING feature. | ||
| Param | MESSAGE_ID | Id of the message (24 hex-char string) | |
| Query | to | String | Fax number (E.164 format) or e-mail address of the recipient |
Query example
https://api.telecomx.dk/mailbox/1234567890ABCDEF12345678/forward?to=donald@duck.com
Response
| Json object | ||
|---|---|---|
| success | Boolean | True on success |
Example
{ success: true }
Errors
| Error code | Message | Description |
|---|---|---|
| 400 | bad_request | Id not found in request URI |
| 404 | id | Message not found |
| 422 | to | the recipient to send the message to is invalid |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/mailbox/forward.txt · Last modified: 2023/10/30 14:04 by Per Møller