Voicemail Drops


Search

Search for voicemail drops.

Endpoint

Method URI Description
GET /users/{user_id}/voicemail_drops Search user owned voicemail drops

Example Response

{
    "data": [
        {
            "id": 2,
            "provider": "Slybroadcast",
            "media_id": 343,
            "callback_number": "7272329117",
            "name": "My First Send",
            "description": null,
            "status": "Sent",
            "reason": "Billing subscription not found.",
            "send_type": "Future",
            "send_at": "2019-07-12T16:56:00Z",
            "sending_at": "2019-07-12T16:57:06Z",
            "sent_at": "2019-07-12T16:57:09Z",
            "recipients": [
                {
                    "group": "Tags",
                    "label": "Sphere Tag",
                    "value": 403131
                }
            ],
            "reporting": {
                "date": null,
                "sent": 2,
                "processed": 0,
                "delivered": 0,
                "open": 0,
                "click": 0,
                "reply": 0,
                "spamreport": 0,
                "unsubscribe": 0,
                "deferred": 0,
                "dropped": 0,
                "bounce": 0,
                "hard_bounce": 0,
                "soft_bounce": 0,
                "failed": 0
            },
            "created_at": "2019-07-12T16:53:30Z",
            "updated_at": "2019-07-12T16:57:09Z",
            "deleted_at": null,
            "media": {
                "id": 343,
                "name": "vet",
                "file_name": "vet.mp3",
                "collection_name": "audio",
                "mime_type": "audio/mpeg",
                "size": 664755,
                "readable_size": "649.17 KB",
                "full_url": "https://s3.amazonaws.com/cdn.happygrasshopper.com/production/629d56a54c6276cd725edf9ec92c962da94acdc478297a5772c8e6181e317983/vet.mp3",
                "download_url": "https://myauth.happygrasshopper.com/download/69386f63-9920-42e6-a71d-8e93e50dca69",
                "created_at": "2019-07-12T16:53:00Z",
                "updated_at": "2019-07-12T16:53:01Z",
                "deleted_at": null
            }
        }
        ],
    "links": {
        "first": "http://api.happygrasshopper.com/v3/users/77179/voicemail_drops?page=1",
        "last": "http://api.happygrasshopper.com/v3/users/77179/voicemail_drops?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://api.happygrasshopper.com/v3/users/77179/voicemail_drops",
        "per_page": 15,
        "to": 4,
        "total": 4
    }
}

Create

Create an voicemail drop.

Endpoint

Method URI Description
POST /users/{user_id}/voicemail_drops Create a user owned voicemail drop

Body Params

{
    "provider": "Slybroadcast",
    "media_id": 343,
    "callback_number": "7272329117",
    "name": "My First Send",
    "description": null,
    "status": "Sent",
    "reason": "Billing subscription not found.",
    "send_type": "Future",
}

Example Response

{
    "id": 2,
    "provider": "Slybroadcast",
    "media_id": 343,
    "callback_number": "7272329117",
    "name": "My First Send",
    "description": null,
    "status": "Sent",
    "reason": "Billing subscription not found.",
    "send_type": "Future",
    "send_at": "2019-07-12T16:56:00Z",
    "sending_at": "2019-07-12T16:57:06Z",
    "sent_at": "2019-07-12T16:57:09Z",
    "recipients": [
        {
            "group": "Tags",
            "label": "Sphere Tag",
            "value": 403131
        }
    ],
    "reporting": {
        "date": null,
        "sent": 2,
        "processed": 0,
        "delivered": 0,
        "open": 0,
        "click": 0,
        "reply": 0,
        "spamreport": 0,
        "unsubscribe": 0,
        "deferred": 0,
        "dropped": 0,
        "bounce": 0,
        "hard_bounce": 0,
        "soft_bounce": 0,
        "failed": 0
    },
    "created_at": "2019-07-12T16:53:30Z",
    "updated_at": "2019-07-12T16:57:09Z",
    "deleted_at": null,
    "media": {
        "id": 343,
        "name": "vet",
        "file_name": "vet.mp3",
        "collection_name": "audio",
        "mime_type": "audio/mpeg",
        "size": 664755,
        "readable_size": "649.17 KB",
        "full_url": "https://s3.amazonaws.com/cdn.happygrasshopper.com/production/629d56a54c6276cd725edf9ec92c962da94acdc478297a5772c8e6181e317983/vet.mp3",
        "download_url": "https://myauth.happygrasshopper.com/download/69386f63-9920-42e6-a71d-8e93e50dca69",
        "created_at": "2019-07-12T16:53:00Z",
        "updated_at": "2019-07-12T16:53:01Z",
        "deleted_at": null
    }
}

Read

Retrieve an voicemail drop.

Endpoint

Method URI Description
GET /voicemail_drops/{voicemail_drop_id} Retrieve an voicemail drop by it's id

Example Response

{
    "id": 2,
    "provider": "Slybroadcast",
    "media_id": 343,
    "callback_number": "7272329117",
    "name": "My First Send",
    "description": null,
    "status": "Sent",
    "reason": "Billing subscription not found.",
    "send_type": "Future",
    "send_at": "2019-07-12T16:56:00Z",
    "sending_at": "2019-07-12T16:57:06Z",
    "sent_at": "2019-07-12T16:57:09Z",
    "recipients": [
        {
            "group": "Tags",
            "label": "Sphere Tag",
            "value": 403131
        }
    ],
    "reporting": {
        "date": null,
        "sent": 2,
        "processed": 0,
        "delivered": 0,
        "open": 0,
        "click": 0,
        "reply": 0,
        "spamreport": 0,
        "unsubscribe": 0,
        "deferred": 0,
        "dropped": 0,
        "bounce": 0,
        "hard_bounce": 0,
        "soft_bounce": 0,
        "failed": 0
    },
    "created_at": "2019-07-12T16:53:30Z",
    "updated_at": "2019-07-12T16:57:09Z",
    "deleted_at": null,
    "media": {
        "id": 343,
        "name": "vet",
        "file_name": "vet.mp3",
        "collection_name": "audio",
        "mime_type": "audio/mpeg",
        "size": 664755,
        "readable_size": "649.17 KB",
        "full_url": "https://s3.amazonaws.com/cdn.happygrasshopper.com/production/629d56a54c6276cd725edf9ec92c962da94acdc478297a5772c8e6181e317983/vet.mp3",
        "download_url": "https://myauth.happygrasshopper.com/download/69386f63-9920-42e6-a71d-8e93e50dca69",
        "created_at": "2019-07-12T16:53:00Z",
        "updated_at": "2019-07-12T16:53:01Z",
        "deleted_at": null
    }
}

Update

Update an voicemail drop.

Endpoint

Method URI Description
PUT /voicemail_drops/{voicemail_drop_id} Update an voicemail drop

Body Params

{
    "provider": "Slybroadcast",
    "media_id": 343,
    "callback_number": "7272329117",
    "name": "My First Send",
    "description": null,
    "status": "Sent",
    "reason": "Billing subscription not found.",
    "send_type": "Future",
}

Example Response

{
    "id": 2,
    "provider": "Slybroadcast",
    "media_id": 343,
    "callback_number": "7272329117",
    "name": "My First Send",
    "description": null,
    "status": "Sent",
    "reason": "Billing subscription not found.",
    "send_type": "Future",
    "send_at": "2019-07-12T16:56:00Z",
    "sending_at": "2019-07-12T16:57:06Z",
    "sent_at": "2019-07-12T16:57:09Z",
    "recipients": [
        {
            "group": "Tags",
            "label": "Sphere Tag",
            "value": 403131
        }
    ],
    "reporting": {
        "date": null,
        "sent": 2,
        "processed": 0,
        "delivered": 0,
        "open": 0,
        "click": 0,
        "reply": 0,
        "spamreport": 0,
        "unsubscribe": 0,
        "deferred": 0,
        "dropped": 0,
        "bounce": 0,
        "hard_bounce": 0,
        "soft_bounce": 0,
        "failed": 0
    },
    "created_at": "2019-07-12T16:53:30Z",
    "updated_at": "2019-07-12T16:57:09Z",
    "deleted_at": null,
    "media": {
        "id": 343,
        "name": "vet",
        "file_name": "vet.mp3",
        "collection_name": "audio",
        "mime_type": "audio/mpeg",
        "size": 664755,
        "readable_size": "649.17 KB",
        "full_url": "https://s3.amazonaws.com/cdn.happygrasshopper.com/production/629d56a54c6276cd725edf9ec92c962da94acdc478297a5772c8e6181e317983/vet.mp3",
        "download_url": "https://myauth.happygrasshopper.com/download/69386f63-9920-42e6-a71d-8e93e50dca69",
        "created_at": "2019-07-12T16:53:00Z",
        "updated_at": "2019-07-12T16:53:01Z",
        "deleted_at": null
    }
}

Delete

Delete an voicemail drop.

Endpoint

Method URI Description
DELETE /voicemail_drops/{voicemail_drop_id} Delete an voicemail drop by it's id

Example Response

{
    "success": true
}