Voice Messaging¶

Display voice messaging options¶

GET /api/v1/tenants/(string: tenant_id)/services/voice_messaging/¶

Display voice messaging options at tenant level.

Example request:

GET /api/v1/tenants/foo/services/voice_messaging/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "voiceMessageDelivery": {
      "systemDefault": true,
      "fromAddress": ""
   },
   "voiceMessageNotification": {
      "systemDefault": false,
      "fromAddress": "christophe.bury@netaxis.be"
   },
   "voicePortalPasscodeLockout": {
      "systemDefault": true,
      "fromAddress": ""
   }
}

Response JSON Object:

voiceMessageDelivery (object) – Options set for Voice Message Delivery. See Tenant Voice Messaging Object.
voiceMessageNotification (object) – Options set for Voice Message Notification. See Tenant Voice Messaging Object.
voicePortalPasscodeLockout (object) – Options set for Voice Portal Passcode Lockout. See Tenant Voice Messaging Object.

Status Codes:

200 OK – no error

Modify voice messaging options¶

PUT /api/v1/tenants/(string: tenant_id)/services/voice_messaging/¶

Update the voice messaging options at tenant level.

Authorization Right: Minimum Tenant Admin.

Example request:

PUT /api/v1/tenants/foo/licenses/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "voiceMessageDelivery": {
      "systemDefault": false,
      "fromAddress": "olivier.rousseau@netaxis.be"
   },
   "voiceMessageNotification": {
      "systemDefault": true
   }
}

Request JSON Object:

voiceMessageDelivery (object) – (Optional) Options set for Voice Message Delivery. See Tenant Voice Messaging Object.
voiceMessageNotification (object) – (Optional) Options set for Voice Message Notification. See Tenant Voice Messaging Object.
voicePortalPasscodeLockout (object) – (Optional) Options set for Voice Portal Passcode Lockout. See Tenant Voice Messaging Object.

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "voiceMessageDelivery": {
      "systemDefault": false,
      "fromAddress": "olivier.rousseau@netaxis.be"
   },
   "voiceMessageNotification": {
      "systemDefault": true
      "fromAddress": "christophe.bury@netaxis.be"
   },
   "voicePortalPasscodeLockout": {
      "systemDefault": true,
      "fromAddress": ""
   }
}

Response JSON Object:

voiceMessageDelivery (object) – Options set for Voice Message Delivery. See Tenant Voice Messaging Object.
voiceMessageNotification (object) – Options set for Voice Message Notification. See Tenant Voice Messaging Object.
voicePortalPasscodeLockout (object) – Options set for Voice Portal Passcode Lockout. See Tenant Voice Messaging Object.

Status Codes:

200 OK – request was processed without error
400 Bad Request – invalid data

Tenant Voice Messaging Object¶

Name	Type	Method		Description
Name	Type	GET	PUT	Description
systemDefault	Boolean	A	O	Use System Default From E-mail Address.
fromAddress	String	A	O	Default From Email Address.