3rd Party Voice Mail Services

Display user’s 3rd Party Voice Mail

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/user_3d_party_vm/

Retrieve the settings of the 3rd Party Voice Mail service of the user.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/user_3d_party_vm/ HTTP/1.1
Host: example.com

Example response:

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

{
    "active": false,
    "busyRedirectToVoiceMail": true,
    "noAnswerRedirectToVoiceMail": true,
    "serverSelection": "Group Mail Server",
    "userServer": "",
    "mailboxIdType": "User Or Group Phone Number",
    "mailboxURL": "",
    "noAnswerNumberOfRings": 3,
    "alwaysRedirectToVoiceMail": false
}
Response JSON Object:

  • active (boolean) – the status of the service

  • busyRedirectToVoiceMail (boolean) – specify if redirects all busy calls to voice mail

  • noAnswerRedirectToVoiceMail (boolean) – specify if redirects all unanswered calls to voice mail

  • serverSelection (string) – third Party Voice Mail user-level voice mail server choices

  • userServer (string) – uniquely identifies an external voice mail server for the service

  • mailboxIdType (string) – Mailbox Id type on Third Party Voice Mail platform for the service

  • mailboxURL (string) – the SIP URI to identify the mailbox for the service

  • noAnswerNumberOfRings (integer) – Number of Rings until call is redirected to voice mail for the service

  • alwaysRedirectToVoiceMail (boolean) – specify if redirects all calls unconditionally to voice mail

Status Codes:

Update a user’s 3rd Party Voice Mail

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/user_3d_party_vm/

Update the settings of the 3rd Party Voice Mail service of the user.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/user_3d_party_vm/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
    "active": true,
    "busyRedirectToVoiceMail": true,
    "noAnswerRedirectToVoiceMail": true,
    "serverSelection": "User Specific Mail Server",
    "userServer": "",
    "mailboxIdType": "URL",
    "mailboxURL": "",
    "noAnswerNumberOfRings": 10,
    "alwaysRedirectToVoiceMail": false
}

Example response:

HTTP/1.1 200 OK
Request JSON Object:

  • active (boolean) – the status of the service

  • busyRedirectToVoiceMail (boolean) – specify if redirects all busy calls to voice mail

  • noAnswerRedirectToVoiceMail (boolean) – specify if redirects all unanswered calls to voice mail

  • serverSelection (string) – third Party Voice Mail user-level voice mail server choices

  • userServer (string) – uniquely identifies an external voice mail server for the service

  • mailboxIdType (string) – Mailbox Id type on Third Party Voice Mail platform for the service

  • mailboxURL (string) – the SIP URI to identify the mailbox for the service

  • noAnswerNumberOfRings (integer) – Number of Rings until call is redirected to voice mail for the service

  • alwaysRedirectToVoiceMail (boolean) – specify if redirects all calls unconditionally to voice mail

Status Codes: