Voicemails

Manage voicemail functions.

List voicemails

get

Retrieve a collection of voicemails.

Authorizations

bearer

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

4XX

Error

get

/voicemails

HTTPcURLJavaScriptPython

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

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "sender": "text",
      "created_at": "2017-07-21T17:32:28Z",
      "duration": 1,
      "status": "READ",
      "file_name": "text",
      "file_size": 0,
      "file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"
    }
  ]
}

Retrieve a voicemail

get

Retrieve voicemail information.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of voicemail.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/voicemails/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "sender": "text",
  "created_at": "2017-07-21T17:32:28Z",
  "duration": 1,
  "status": "READ",
  "file_name": "text",
  "file_size": 0,
  "file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"
}

Update voicemail status to read

post

Update voicemail status to read

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of voicemail.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

400

Invalid voicemail ID supplied

post

/voicemails/{id}/set_read

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of voicemail.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

400

Invalid voicemail ID supplied

post

/voicemails/{id}/set_unread

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of voicemail.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

400

Invalid voicemail ID supplied

404

User not found

post

/voicemails/{id}/destroy

HTTPcURLJavaScriptPython

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

No content