Voicemail drop records

A voicemail drop record stores information about a direct-to-voicemail drop.

Fields

class VoicemailDropRecord

campaign: integer: The campaign the job belongs to.

id: integer: The voicemail drop record’s unique ID.

job: integer: The voicemail drop record’s job.

number: string: The voicemail recipient’s phone number, in international format.

reference: string: Your reference for this job (e.g. customer ID), which must be unique within the campaign.

state: integer

The voicemail’s delivery state.

0 = sent
1 = delivered
2 = failed
3 = rejected

team: integer: The voicemail drop record’s team.

timestamp: datetime: The voicemail drop record’s date and time.

API

GET /j/voicemail_drop_records

Retrieves the list of voicemail drop records.

You must specify a start date and an end date.

Example request:

GET /j/voicemail_drop_records?start=2015-01-06T00:00:00Z&end=2015-01-07T00:00:00Z&team=1 HTTP/1.1
Authorization: Bearer 0a1b2c3d4e5f

Example response:

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

[
   {
      "campaign": 1,
      "id": 1,
      "job": 1,
      "number": "+33612345678",
      "reference": "123456",
      "state": 0,
      "team": 1,
      "timestamp": "2015-01-06T10:21:14.243Z"
    }
]

Request Headers:

Authorization – OAuth token to authenticate

Query Parameters:

end (datetime) – An end date and time.
start (datetime) – A start date and time.
team (integer) – An optional team ID.

Response JSON Array of Objects:

campaign (integer) – The campaign the job belongs to.
id (integer) – The voicemail drop record’s unique ID.
job (integer) – The voicemail drop record’s job.
number (string) – The voicemail recipient’s phone number, in international format.
reference (string) – Your reference for this job (e.g. customer ID), which must be unique within the campaign.
state (integer) – The voicemail’s delivery state.
team (integer) – The voicemail drop record’s team.
timestamp (datetime) – The voicemail drop record’s date and time.

Status Codes:

200 OK – no error
400 Bad Request – for instance a required field is missing
403 Forbidden – you tried to access a forbidden resource, check you provided a valid OAuth token