Voicemails

List shared voicemail mails

Retrieve a collection of shared voicemail mails.

GEThttp://127.0.0.1:8888/api/shared_voicemails/{id}/voicemails

Path parameters

id*all of

The unique ID of shared voicemail.

Query parameters

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/shared_voicemails/{id}/voicemails', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 100,
  "items": [
    {
      "id": {},
      "sender": "text",
      "created_at": {},
      "duration": 0,
      "status": "READ",
      "file_name": "text",
      "file_size": 0,
      "file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"
    }
  ]
}

Retrieve a shared voicemail mail

Retrieve shared voicemail mail details.

GEThttp://127.0.0.1:8888/api/shared_voicemails/{id}/voicemails/{mail_id}

Path parameters

id*all of

The unique ID of shared voicemail.

mail_id*all of

The unique ID of voicemail.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of voicemail.

senderstring

The sender number of the voicemail.

created_atall of

The creation time of voicemail.

durationinteger (int32)

The playback time (in seconds).

statusenum

Status of the voicemail includes:

• READ: read mail
• UNREAD: unread mail

READUNREAD

file_namestring

The name of the file.

file_sizeinteger (int64)

The file size in bytes.

Example: 0

file_urlstring

The relative path to file url for file downloading.

Example: "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/shared_voicemails/{id}/voicemails/{mail_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": {},
  "sender": "text",
  "created_at": {},
  "duration": 0,
  "status": "READ",
  "file_name": "text",
  "file_size": 0,
  "file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"
}