Yay.com loading

Loading

  • My Shopping Cart (0) £0.00

  • Register

Voicemails & Mailboxes

API Access

Build custom apps using our JSON API

FREE
Get your free API Key

Mailbox Messages

Mailbox Messages are Voicemails that have been left on a Mailbox

Get your free API Key

Filter:

  • All
  • GET
  • POST
  • PUT
  • DELETE
  • Chargeable *

* You will be charged every time this command is run.

  • GET/voip/mailbox/{uuid}/messages

    Gets all messages in the specified mailbox

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Mailbox to be queried

    Response Details

    200 Response

    {
        "result" : [
            {
                "uuid" : "d5f0ea25-bfd8-4b02-8a70-1cc089473962",
                "duration" : 143,
                "caller_id" : "+443301226000",
                "callee_id" : "+443301226000",
                "message_date" : "2017-02-28"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/voip/mailbox/{mailbox_uuid}/messages/{message_uuid}

    Gets the details for a specific mailbox message

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • mailbox_uuid

      • String

      • True

      The UUID of the Mailbox to be queried

      • message_uuid

      • String

      • True

      The UUID of the Message to be queried

    Response Details

    200 Response

    {
        "result" : {
            "uuid" : "d5f0ea25-bfd8-4b02-8a70-1cc089473962",
            "duration" : 143,
            "caller_id" : "+443301226000",
            "callee_id" : "+443301226000",
            "message_date" : "2017-02-28"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • GET/voip/mailbox/{mailbox_uuid}/messages/{message_uuid}/content

    Generates a temporary URL to the message's audio content

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • mailbox_uuid

      • String

      • True

      The UUID of the Mailbox to be queried

      • message_uuid

      • String

      • True

      The UUID of the Message to be queried

    Response Details

    200 Response

    {
        "result" : {
            "voicemail" : "https://voicemail.yay.com/a68e58ed-60ed-4198-a693-3dbadd6e1094.mp3"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • DELETE/voip/mailbox/{mailbox_uuid}/messages/{message_uuid}

    Deletes the specified mailbox message

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • mailbox_uuid

      • String

      • True

      The UUID of the Mailbox to be queried

      • message_uuid

      • String

      • True

      The UUID of the Message to be deleted

    Response Details

    204 Response

    {
        "result" : {},
        "status_code" : 204,
        "status_message" : "No Content"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
View Desktop Site