Yay.com loading

Loading

Call us on 0330 122 6000

Login to Yay.com

VoIP Phone Short Code

API Access

Build custom apps using our JSON API

FREE
Get your free API Key

Short Codes

A Short Code is a code that can be dialled to modify the behaviour of a call

Get your free API Key

Filter:

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

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

  • GET/voip/short-code

    Gets a list of all of the active short codes 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" : [
            {
                "short_code" : "*50",
                "feature" : {
                    "feature" : "listen"
                },
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2018-01-17",
                "updated_on" : "2018-01-17"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/voip/short-code/{uuid}

    Gets the details for a specific short code 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 Short Code to be queried

    Response Details

    200 Response

    {
        "result" : {
            "short_code" : "*50",
            "feature" : {
                "feature" : "listen"
            },
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2018-01-17",
            "updated_on" : "2018-01-17"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

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

    Creates a new short code. Short codes must be a * or # followed by 2 numerical digits

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

      • feature

      • Map of String

      • True

      The details for the feature this Short Code implements

      • short_code

      • String

      • True

      The code to be dialled. This should be a '*' or '#' followed by 2 numerical digits.

    JSON all-fields example:

    {
        "short_code" : "*50",
        "feature" : {
            "feature" : "listen"
        }
    }

    Response Details

    201 Response

    {
        "result" : {
            "short_code" : "*50",
            "feature" : {
                "feature" : "listen"
            },
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2018-01-17"
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    400 Response

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

    409 Response

    {
        "result" : {},
        "status_code" : 409,
        "status_message" : "Conflict"
    }
  • PUT/voip/short-code/{uuid}

    Updates the specified short code

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Short Code to be updated

    PUT body

    • Name

    • Type

    • Required

      • feature

      • Map of String

      • True

      The details for the feature this Short Code implements

      • short_code

      • String

      • True

      The code to be dialled. This should be a '*' or '#' followed by 2 numerical digits.

    JSON all-fields example:

    {
        "short_code" : "*50",
        "feature" : {
            "feature" : "listen"
        }
    }

    Response Details

    200 Response

    {
        "result" : {
            "short_code" : "*50",
            "feature" : {
                "feature" : "listen"
            },
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2018-01-17",
            "updated_on" : "2018-01-17"
        },
        "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/short-code/{uuid}

    Deletes the specified short code

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Short Code 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