Voicemails

Manage voicemail functions.

List voicemails

get

Retrieve a collection of voicemails.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get/voicemails

GET /api/voicemails HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "id": "1004948204782882816",
      "sender": "test [ 101 ]",
      "sender_name": "test",
      "sender_number": "101",
      "created_at": "2020-01-01T00:00:00Z",
      "status": "UNREAD",
      "duration": 3,
      "file_name": "a18b846a-2979-4ce8-bbf0-5d45fe4e2dfa.wav",
      "file_size": 236,
      "file_url": "/api/blobs/1A5uEsvFUWqMfIp0l_PkzAAAgFoRS_IN",
      "transcription_status": "TRANSCRIPTION_QUOTALIMITED",
      "transcription_status_desc": "description of status",
      "transcription_sentiment": "SENTIMENT_NEUTRAL"
    }
  ]
}

Retrieve a voicemail

get

Retrieve voicemail information.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

senderstringOptionalDeprecated

The formated sender of the voicemail.

sender_namestringOptional

The sender name of the voicemail.

sender_numberstringOptional

The sender number of the voicemail.

created_atstring · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

durationinteger · int32Optional

The playback time (in seconds).

statusstring · enumOptional

Status of the voicemail includes:

• READ: read mail
• UNREAD: unread mail

Possible values:

file_namestringOptional

The name of the file.

file_sizeinteger · int64Optional

The file size in bytes.

Example: 0

file_urlstringRead-onlyOptional

The relative path to file url for file downloading.

Example: /api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK

4XX

Error

get/voicemails/{id}

GET /api/voicemails/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "xxxxxx",
  "sender": "test [ 101 ]",
  "sender_name": "test",
  "sender_number": "101",
  "created_at": "2020-01-01T00:00:00Z",
  "duration": 3,
  "status": "UNREAD",
  "file_name": "example",
  "file_size": 100,
  "file_url": ""
}

Update voicemail status to read

post

Update voicemail status to read

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

400

Invalid voicemail ID supplied

post/voicemails/{id}/set_read

POST /api/voicemails/{id}/set_read HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update voicemail status to unread

post

Update voicemail status to unread

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

400

Invalid voicemail ID supplied

post/voicemails/{id}/set_unread

POST /api/voicemails/{id}/set_unread HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete a voicemail

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

No content

400

Invalid voicemail ID supplied

404

User not found

post/voicemails/{id}/destroy

POST /api/voicemails/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content