Voice Messaging¶

Voice Portal¶

Retrieve configuration¶

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

Get the details about the voice portal of the group.

Example request:

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

Example response:

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

{
   "voicePortalExternalRoutingScope": "System",
   "serviceUserId": "143084634_101898682_VMR@sip.netaxis.be",
   "serviceUserProfile": {
      "name": "Voice Portal",
      "cliFirstName": "Voice Portal",
      "cliLastName": "Voice Portal",
      "cliPhoneNumber": null,
      "language": "English",
      "extension": "1777",
      "phoneNumber": "",
      "department": "",
      "timeZone": "Europe/Brussels",
      "aliases": [
         "aliases99@sip.netaxis.be",
         "test@sip.netaxis.be"
      ],
      "publicUserIdentity": ""
   },
   "active": true,
   "enableExtendedScope": true,
   "useExternalRouting": false,
   "useVoicePortalWizard": true,
   "enableAllAuthentifications": true,
   "externalRoutingAddress": "123456879"
}

Response JSON Object:

serviceUserId (string) – See serviceUserId from Voice Portal Instance.
serviceUserProfile (object) – See serviceUserProfile from Voice Portal Instance.
active (boolean) – See active from Voice Portal Instance.
enableExtendedScope (boolean) – See enableExtendedScope from Voice Portal Instance.
enableAllAuthentifications (boolean) – See enableAllAuthentifications from Voice Portal Instance.
useVoicePortalWizard (boolean) – See useVoicePortalWizard from Voice Portal Instance.
voicePortalExternalRoutingScope (string) – See voicePortalExternalRoutingScope from Voice Portal Instance.
useExternalRouting (string) – See useExternalRouting from Voice Portal Instance.
externalRoutingAddress (string) – See externalRoutingAddress from Voice Portal Instance.
homeZoneName (string) – See homeZoneName from Voice Portal Instance.
networkClassOfService (string) – See networkClassOfService from Voice Portal Instance.

Status Codes:

200 OK – no error.

Update configuration¶

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

Update the details about the voice portal of the group.

Example request:

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

{
   "serviceUserProfile": {
      "cliFirstName": "Voice Portal",
      "cliPhoneNumber": null,
      "cliLastName": "Voice Portal",
      "publicUserIdentity": "",
      "aliases": [],
      "name": "Voice Portal",
      "language": "English",
      "extension": "1777",
      "phoneNumber": "",
      "department": "",
      "timeZone": "Europe/Brussels"
   },
   "active": false,
   "enableExtendedScope": true,
   "enableAllAuthentifications": true,
   "useVoicePortalWizard": true,
   "voicePortalExternalRoutingScope": "System",
   "useExternalRouting": true,
   "externalRoutingAddress": "12348457',
}

Request JSON Object:

serviceUserProfile (object) – See serviceUserProfile from Voice Portal Instance.
active (boolean) – See active from Voice Portal Instance.
enableExtendedScope (boolean) – See enableExtendedScope from Voice Portal Instance.
enableAllAuthentifications (boolean) – See enableAllAuthentifications from Voice Portal Instance.
useVoicePortalWizard (boolean) – See useVoicePortalWizard from Voice Portal Instance.
voicePortalExternalRoutingScope (string) – See voicePortalExternalRoutingScope from Voice Portal Instance.
useExternalRouting (string) – See useExternalRouting from Voice Portal Instance.
externalRoutingAddress (string) – See externalRoutingAddress from Voice Portal Instance.
homeZoneName (string) – See homeZoneName from Voice Portal Instance.
networkClassOfService (string) – See networkClassOfService from Voice Portal Instance.

Response:

Similar to GET instance method response.

Status Codes:

200 OK – no error.
400 Bad Request – failed to update.