Yay.com loading

Loading

  • My Shopping Cart (0) £0.00

  • Register

Caller ID

API Access

Build custom apps using our JSON API

FREE
Get your free API Key

Caller IDs

Caller IDs are the numbers an account is authorized to display as on outbound calls

Get your free API Key

Filter:

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

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

  • GET/voip/caller-id

    Gets all of the active Caller IDs 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" : "8779542b-1995-422c-881b-929a29f4ddb7",
                "cli_display" : "+443301226020",
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2017-05-28",
                "updated_on" : "2017-05-28"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/voip/caller-id/{uuid}

    Gets a specific Caller ID 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 Caller ID to be updated

    Response Details

    200 Response

    {
        "result" : {
            "number" : "8779542b-1995-422c-881b-929a29f4ddb7",
            "cli_display" : "+443301226020",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-05-28",
            "updated_on" : "2017-05-28"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

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

    Deletes the specified Caller ID 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 Caller ID 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