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 Authorized Senders

Commands to manage who is allowed to send faxes via the fax to email system

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/sender

    Gets a list of all the currently authorized fax senders on the account

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    Response Details

    200 Response

    {
        "result" : [
            {
                "email" : "help@yay.com",
                "caller_id" : "09c1b1a7-b5d5-457f-a0aa-dc78d0205760",
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2017-05-26",
                "updated_on" : "2017-05-26"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/voip/fax/sender/{uuid}

    Gets a specific fax sender on the 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 Sender to be queried

    Response Details

    200 Response

    {
        "result" : {
            "email" : "help@yay.com",
            "caller_id" : "09c1b1a7-b5d5-457f-a0aa-dc78d0205760",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-05-26",
            "updated_on" : "2017-05-26"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

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

    Creates a new authorized fax sender

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

      • caller_id

      • String

      • True

      The UUID of the caller_id used when this sender sends a fax

      • email

      • String

      • True

      The email address authorized to send faxes from this account

    JSON all-fields example:

    {
        "email" : "help@yay.com",
        "caller_id" : "09c1b1a7-b5d5-457f-a0aa-dc78d0205760"
    }

    Response Details

    201 Response

    {
        "result" : {
            "email" : "help@yay.com",
            "caller_id" : "09c1b1a7-b5d5-457f-a0aa-dc78d0205760",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-05-26"
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    400 Response

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

    Updates the specified authorized fax sender

    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 Sender to be updated

    PUT body

    • Name

    • Type

    • Required

      • caller_id

      • String

      • True

      The UUID of the caller_id used when this sender sends a fax

      • email

      • String

      • True

      The email address authorized to send faxes from this account

    JSON all-fields example:

    {
        "email" : "help@yay.com",
        "caller_id" : "09c1b1a7-b5d5-457f-a0aa-dc78d0205760"
    }

    Response Details

    200 Response

    {
        "result" : {
            "email" : "help@yay.com",
            "caller_id" : "09c1b1a7-b5d5-457f-a0aa-dc78d0205760",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-05-26",
            "updated_on" : "2017-05-26"
        },
        "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"
    }

    409 Response

    {
        "result" : {},
        "status_code" : 409,
        "status_message" : "Conflict"
    }
  • DELETE/voip/fax/sender/{uuid}

    Deletes the specified fax sender

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