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

Mailboxes

Mailboxes are used in call routes to allow callers to leave a voicemail message

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

    Gets all active mailboxes on an account

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    Response Details

    200 Response

    {
        "result" : [
            {
                "name" : "Pete's Mailbox",
                "password" : "1234",
                "greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
                "email_recipients" : [],
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2017-02-28",
                "updated_on" : "2017-02-28"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/voip/mailbox/{uuid}

    Gets the details for a specific mailbox on an account

    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" : {
            "name" : "Pete's Mailbox",
            "password" : "1234",
            "greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
            "email_recipients" : [],
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-02-28",
            "updated_on" : "2017-02-28"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • POST/voip/mailbox

    Creates a new Mailbox

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

      • greeting

      • String

      • False

      The UUID of the Sound used as a greeting

      • name

      • String

      • True

      The name of this Mailbox

      • password

      • String

      • False

      The 4 digit pass code required to access this mailbox

    MailboxEmailRecipient

      • email_address

      • String

      • True

      The email address of this Email Recipient

    JSON all-fields example:

    {
        "name" : "Pete's Mailbox",
        "password" : "1234",
        "greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b"
    }

    Response Details

    201 Response

    {
        "result" : {
            "name" : "Pete's Mailbox",
            "password" : "1234",
            "greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
            "email_recipients" : [],
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-02-28"
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }
  • PUT/voip/mailbox/{uuid}

    Updates 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 updated

    PUT body

    • Name

    • Type

    • Required

      • greeting

      • String

      • False

      The UUID of the Sound used as a greeting

      • name

      • String

      • True

      The name of this Mailbox

      • password

      • String

      • False

      The 4 digit pass code required to access this mailbox

    MailboxEmailRecipient

      • email_address

      • String

      • True

      The email address of this Email Recipient

    JSON all-fields example:

    {
        "name" : "Pete's Mailbox",
        "password" : "1234",
        "greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b"
    }

    Response Details

    200 Response

    {
        "result" : {
            "name" : "Pete's Mailbox",
            "password" : "1234",
            "greeting" : "63e54af8-07b5-4fd2-b15b-f4c31a82ca0b",
            "email_recipients" : [],
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-02-28",
            "updated_on" : "2017-02-28"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    404 Response

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

    Deletes 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 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