Yay.com loading

Loading

  • My Shopping Cart (0) £0.00

  • Register

eFax Management

API Access

Build custom apps using our JSON API

FREE
Get your free API Key

Fax Messages

Commands to manage fax messages received on an account

Get your free API Key

Filter:

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

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

  • GET/voip/fax/message

    Gets a list of all the fax messages 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" : [
            {
                "number" : "a68e58ed-60ed-4198-a693-3dbadd6e1094",
                "caller_id" : "+443301226000",
                "page_count" : 1,
                "is_outbound" : true,
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2017-11-17",
                "updated_on" : "2017-11-17"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/voip/fax/message/{uuid}

    Gets the details for a specific fax message 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 Fax Message to be queried

    Response Details

    200 Response

    {
        "result" : {
            "number" : "a68e58ed-60ed-4198-a693-3dbadd6e1094",
            "caller_id" : "+443301226000",
            "page_count" : 1,
            "is_outbound" : true,
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-11-17",
            "updated_on" : "2017-11-17"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • GET/voip/fax/message/{uuid}/content

    Generates a temporary URL to the fax's content (as PDF)

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Fax Message to be queried

    Response Details

    200 Response

    {
        "result" : {
            "content_url" : "content.yay.com/40c6614b-8c5d-48a0-ab6d-cdc4d47f914d"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

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

    Deletes the specified fax message from 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 Fax 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