Yay.com loading

Loading

Call us on (888) YAY-8747

0

Login to Yay.com

Caller ID Requests

Caller ID Requests track the progress of requests to use numbers not on an account as Caller IDs

Become a Reseller

Filter:

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

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

  • GET/voip/cli-request

    Gets a list of all active Caller ID Requests 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" : "+443301226000",
                "documents" : [
                    {
                        "verified" : true,
                        "rejected" : false,
                        "document_uuid" : "a21129ab-8168-4c97-b186-b96a047784df",
                        "type" : "ownership"
                    }
                ],
                "status" : "needs_documents",
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2019-01-19",
                "updated_on" : "2019-01-19"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/voip/cli-request/{uuid}

    Gets a specific Caller ID Request

    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 Request to be queried

    Response Details

    200 Response

    {
        "result" : {
            "number" : "+443301226000",
            "documents" : [
                {
                    "verified" : true,
                    "rejected" : false,
                    "document_uuid" : "a21129ab-8168-4c97-b186-b96a047784df",
                    "type" : "ownership"
                }
            ],
            "status" : "needs_documents",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2019-01-19",
            "updated_on" : "2019-01-19"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

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

    Creates a new alternate Caller ID Request

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

      • number

      • String

      • True

      The number you wish to be able to use as a Caller ID in E164 format

    CallerIdDocument

      • document_uuid

      • String

      • True

      The UUID of the account document to use for this verification type

      • rejected

      • boolean

      • True

      Whether or not this document has been rejected

      • type

      • String

      • True

      The type of verification this document is providing: 'ownership', 'identity', or 'address'

      • verified

      • boolean

      • True

      Whether or not this document has been verified

    JSON all-fields example:

    {
        "number" : "+443301226000"
    }

    Response Details

    201 Response

    {
        "result" : {
            "number" : "+443301226000",
            "documents" : [
                {
                    "verified" : true,
                    "rejected" : false,
                    "document_uuid" : "a21129ab-8168-4c97-b186-b96a047784df",
                    "type" : "ownership"
                }
            ],
            "status" : "needs_documents",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2019-01-19"
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }
  • DELETE/voip/cli-request/{uuid}

    Deletes the specified Caller ID Request 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 Request 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"
    }
  • POST/voip/cli-request/{uuid}/document

    Links an account document to the caller id request for verification. The Document types required are: 'ownership', 'identity', and '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 caller id request to update

    POST body

    • Name

    • Type

    • Required

      • document_uuid

      • String

      • True

      The UUID of the account document to use for this verification type

      • rejected

      • boolean

      • True

      Whether or not this document has been rejected

      • type

      • String

      • True

      The type of verification this document is providing: 'ownership', 'identity', or 'address'

      • verified

      • boolean

      • True

      Whether or not this document has been verified

    JSON all-fields example:

    {
        "verified" : true,
        "rejected" : false,
        "document_uuid" : "a21129ab-8168-4c97-b186-b96a047784df",
        "type" : "ownership"
    }

    Response Details

    201 Response

    {
        "result" : {
            "verified" : true,
            "rejected" : false,
            "document_uuid" : "a21129ab-8168-4c97-b186-b96a047784df",
            "type" : "ownership"
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    400 Response

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

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }