3rd Party Voice Mail

Retrieve configuration

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/3rd_party_vm/

Get the details about the 3rd Party Voice Mail of the group.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/3rd_party_vm/ HTTP/1.1
Host: example.com

Example response:

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

{
   "active": true,
   "groupServer": "voicemail@testtest.com"
}
Response JSON Object:

  • active (boolean) – Indicate if the service is active or not

  • groupServer (object) – Phone number or URL of the external voice mail server in the Third-Party Voice Mail Server box.

Status Codes:

Update configuration

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/3rd_party_vm/

Update the details about the 3rd Party Voice Mail of the group.

Example request:

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

{
   "active": false,
   "groupServer": "+32389857410"
}

Example response:

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

{
   "active": false,
   "groupServer": "+32389857410"
}
Note:

Answer is similar to GET return

Request JSON Object:

  • active (boolean) – (Optional) Indicate if the service is active or not

  • groupServer (object) – (Optional) Phone number or URL of the external voice mail server in the Third-Party Voice Mail Server box.

Status Codes: