Voice Messaging Services¶

The service users are: Call Centers, IVRs and Hunt Groups.

Voice Mail Messages Access¶

List service user’s voice mails¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/service_users/(string: user_id)/services/voice_messaging/voice_mails/¶

Retrieve the list of voice mails of the service user.

Authorization rights: exact Group Admin.

Example request:

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

Example response:

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

{
   "messages": [
      {
         "messageId": "msg_123",
         "time": "2018-05-13 22:34",
         "duration": 4.5,
         "read": false,
         "urgent": true,
         "confidential": true,
         "video": false,
         "fax": false
      }
   ]
}

Response JSON Object:

messages (array) – a list of objects as defined in Voice Messaging Message Info.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the service user

Update a service user’s voice mails status¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/service_users/(string: user_id)/services/voice_messaging/voice_mails/¶

Update the status of several voice mails of the service user.

Authorization rights: exact Group Admin.

Example request:

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

{
   "messages": [
      {
          "messageId": "msg233",
          "read": true
      }
   ]
}

Request JSON Object:

messages (array) – a list of objects as defined in Voice Messaging Message Info.

Example response:

Response:

Similar to GET method response.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the service user
400 Bad Request – error during the update

Retrieve a service user’s voice mail instance¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/service_users/(string: user_id)/services/voice_messaging/voice_mails/(string: instance_name)/¶

Retrieve a voice mail instance of the service user.

Authorization rights: exact Group Admin.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/service_users/foouser/services/voice_messaging/voice_mails/foovm/ HTTP/1.1
Host: example.com

GET /api/v1/tenants/foo/groups/foogroup/service_users/foouser/services/voice_messaging/voice_mails/foovm/ HTTP/1.1
Host: example.com

{
   "outputFormat": "mp3"
}

Example response:

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

{
   "messageInfo" : {
         "time": "2018-05-13 22:34",
         "duration": 4.5,
         "read": false,
         "urgent": true,
         "confidential": true,
         "video": false,
         "fax": false
   }
}

Request JSON Object:

outputFormat (string) – Specify the output format of the messageMediaContent’s content. Supported formats: ‘wav’ (default), ‘mp3’

Response JSON Object:

messageInfo (object) – See Voice Messaging Message Info.
messageMediaContent (object) – See Voice Messaging Message Content.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the service user or the voice mail message does not exists

Update a service user’s voice mail instance¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/service_users/(string: user_id)/services/voice_messaging/voice_mails/(string: instance_name)/¶

Update the properties of a voice mail message of the service user.

Authorization rights: exact Group Admin.

Example request:

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

{
   "time": "2018-05-14 22:34",
   "duration": 4.5,
   "read": true,
   "urgent": false,
   "confidential": false,
}

Request JSON Object:

time (string) – See time from Voice Messaging Message Info.
duration (float) – See duration from Voice Messaging Message Info.
callingPartyInfo (object) – See callingPartyInfo from Voice Messaging Message Info.
read (boolean) – See read from Voice Messaging Message Info.
urgent (boolean) – See urgent from Voice Messaging Message Info.
confidential (boolean) – See confidential from Voice Messaging Message Info.
video (boolean) – See video from Voice Messaging Message Info.
fax (boolean) – See fax from Voice Messaging Message Info.
faxPageCount (integer) – See faxPageCount from Voice Messaging Message Info.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the service user
400 Bad Request – error during the update

Delete a service user’s voice message instance¶

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/service_users/(string: user_id)/services/voice_messaging/voice_mails/(string: instance_name)/¶

Delete a voice mail instance of the service user.

Authorization rights: exact Group Admin.

Example request:

DELETE /api/v1/tenants/foo/groups/foogroup/service_users/foouser/services/voice_messaging/voice_mails/foovm/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{}

Example response:

HTTP/1.1 200 OK

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the service user
400 Bad Request – error during the deletion