Yay.com loading

Loading

Call us on (917) 9001 YAY

Login to Yay.com

EmergencyAddress

Emergency Address can be assigned to numbers for emergency calls

Become a Reseller

Filter:

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

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

  • GET/voip/emergency-address

    Gets all active emergency addresses 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" : [
            {
                "is_default" : true,
                "nickname" : "Work Address",
                "title" : "Mr",
                "forename" : "Pete",
                "name" : "Pete",
                "bussuffix" : "Ltd",
                "premises" : "22",
                "thoroughfare" : "Station Road",
                "locality" : "Guildford",
                "postcode" : "GU2 4BL",
                "country_code" : "GB",
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2018-10-18",
                "updated_on" : "2018-10-18"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/voip/emergency-address/{uuid}

    Gets the details for a specific emergency address 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 Emergency Address to be queried

    Response Details

    200 Response

    {
        "result" : {
            "is_default" : true,
            "nickname" : "Work Address",
            "title" : "Mr",
            "forename" : "Pete",
            "name" : "Pete",
            "bussuffix" : "Ltd",
            "premises" : "22",
            "thoroughfare" : "Station Road",
            "locality" : "Guildford",
            "postcode" : "GU2 4BL",
            "country_code" : "GB",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2018-10-18",
            "updated_on" : "2018-10-18"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • POST/voip/emergency-address

    Creates a new Emergency Address

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

      • bussuffix

      • String

      • True

      The business suffix. Required for Business addresses only

      • country_code

      • String

      • True

      The Country ISO Code

      • forename

      • String

      • True

      The first name of the person this address is for. Required for Individual addresses only

      • is_default

      • boolean

      • True

      Whether or not this is the default emergency address for this Reseller

      • locality

      • String

      • True

      Village or area within a town, and the town

      • name

      • String

      • True

      The surname of the person this address is for if an Individual address. The Business Name if a Business address

      • nickname

      • String

      • True

      The nickname for this emergency address

      • postcode

      • String

      • True

      The post code as recognised by Royal Mail's PAF database, in the form Out-code space In-code

      • premises

      • String

      • True

      The premises on a thoroughfare, e.g. a house number or name

      • thoroughfare

      • String

      • True

      The street name

      • title

      • String

      • True

      The title of the person this address is for. Required for Individual addresses only

    JSON all-fields example:

    {
        "is_default" : true,
        "nickname" : "Work Address",
        "title" : "Mr",
        "forename" : "Pete",
        "name" : "Pete",
        "bussuffix" : "Ltd",
        "premises" : "22",
        "thoroughfare" : "Station Road",
        "locality" : "Guildford",
        "postcode" : "GU2 4BL",
        "country_code" : "GB"
    }

    Response Details

    201 Response

    {
        "result" : {
            "is_default" : true,
            "nickname" : "Work Address",
            "title" : "Mr",
            "forename" : "Pete",
            "name" : "Pete",
            "bussuffix" : "Ltd",
            "premises" : "22",
            "thoroughfare" : "Station Road",
            "locality" : "Guildford",
            "postcode" : "GU2 4BL",
            "country_code" : "GB",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2018-10-18"
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    400 Response

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

    Updates the specified emergency address

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Emergency Address to be updated

    PUT body

    • Name

    • Type

    • Required

      • bussuffix

      • String

      • True

      The business suffix. Required for Business addresses only

      • country_code

      • String

      • True

      The Country ISO Code

      • forename

      • String

      • True

      The first name of the person this address is for. Required for Individual addresses only

      • is_default

      • boolean

      • True

      Whether or not this is the default emergency address for this Reseller

      • locality

      • String

      • True

      Village or area within a town, and the town

      • name

      • String

      • True

      The surname of the person this address is for if an Individual address. The Business Name if a Business address

      • nickname

      • String

      • True

      The nickname for this emergency address

      • postcode

      • String

      • True

      The post code as recognised by Royal Mail's PAF database, in the form Out-code space In-code

      • premises

      • String

      • True

      The premises on a thoroughfare, e.g. a house number or name

      • thoroughfare

      • String

      • True

      The street name

      • title

      • String

      • True

      The title of the person this address is for. Required for Individual addresses only

    JSON all-fields example:

    {
        "is_default" : true,
        "nickname" : "Work Address",
        "title" : "Mr",
        "forename" : "Pete",
        "name" : "Pete",
        "bussuffix" : "Ltd",
        "premises" : "22",
        "thoroughfare" : "Station Road",
        "locality" : "Guildford",
        "postcode" : "GU2 4BL",
        "country_code" : "GB"
    }

    Response Details

    200 Response

    {
        "result" : {
            "is_default" : true,
            "nickname" : "Work Address",
            "title" : "Mr",
            "forename" : "Pete",
            "name" : "Pete",
            "bussuffix" : "Ltd",
            "premises" : "22",
            "thoroughfare" : "Station Road",
            "locality" : "Guildford",
            "postcode" : "GU2 4BL",
            "country_code" : "GB",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2018-10-18",
            "updated_on" : "2018-10-18"
        },
        "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/number-address/{uuid}

    Deletes the specified number address

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Number Address 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"
    }
  • DELETE/voip/emergency-address/{uuid}

    Deletes the specified emergency address

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Emergency Address 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"
    }