Yay.com loading

Loading

  • My Shopping Cart (0) £0.00

  • Register

Phone Calls & CDR Data

API Access

Build custom apps using our JSON API

FREE
Get your free API Key

Call Restrictions

Call Restrictions allow restrictions to be created for outbound VoIP 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/call-restrictions/call-pattern

    Gets all active Call Restriction Patterns 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" : [
            {
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2017-10-20",
                "updated_on" : "2017-10-20"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/voip/call-restrictions/max-call-cost

    Gets the current maximum call cost restriction 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" : {
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-10-20",
            "updated_on" : "2017-10-20"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/voip/call-restrictions/international-exceptions

    Gets all active allowed International Call Restriction Exceptions

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    Response Details

    200 Response

    {
        "result" : [
            {
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2017-10-20",
                "updated_on" : "2017-10-20"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/voip/call-restrictions/international-exception/{uuid}

    Gets a specific allowed International Call Restriction Exception

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the International Call Restriction Exception to be queried

    Response Details

    200 Response

    {
        "result" : {
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-10-20",
            "updated_on" : "2017-10-20"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • GET/voip/call-restrictions/call-pattern/{uuid}

    Gets a specific Call Restriction Pattern 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 Call Restriction Pattern to be queried

    Response Details

    200 Response

    {
        "result" : {
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-10-20",
            "updated_on" : "2017-10-20"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • POST/voip/call-restrictions/international-exception

    Creates a new Call Restriction International Exception

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

    JSON all-fields example:

    {}

    Response Details

    201 Response

    {
        "result" : {
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-10-20"
        },
        "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"
    }
  • POST/voip/call-restrictions/call-pattern

    Creates a new Call Restriction Pattern

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

    JSON all-fields example:

    {}

    Response Details

    201 Response

    {
        "result" : {
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-10-20"
        },
        "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/call-restrictions/call-pattern/{uuid}

    Updates the specified Call Restriction Pattern

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Call Restriction Pattern to be updated

    PUT body

    • Name

    • Type

    • Required

    JSON all-fields example:

    {}

    Response Details

    200 Response

    {
        "result" : {
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-10-20",
            "updated_on" : "2017-10-20"
        },
        "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"
    }
  • PUT/voip/call-restrictions/max-call-cost

    Updates the call restriction maximum call cost

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Sub Reseller to update the max call cost for

      • call_cost_limit

      • String

      • True

      The maximum call cost allowed

    PUT body

    • Name

    • Type

    • Required

    JSON all-fields example:

    {}

    Response Details

    200 Response

    {
        "result" : {
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-10-20",
            "updated_on" : "2017-10-20"
        },
        "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/call-restrictions/international-exception/{uuid}

    Deletes the specified Call Restriction International Exception

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Call Restriction International Exception 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/call-restrictions/max-call-cost

    Deletes the reseller's maximum call cost restriction

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    Response Details

    204 Response

    {
        "result" : {},
        "status_code" : 204,
        "status_message" : "No Content"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • DELETE/voip/call-restrictions/call-pattern/{uuid}

    Deletes the specified Call Restriction Pattern

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Call Restriction Pattern 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/call-restrictions/call-pattern

    Deletes all Call Restriction Patterns

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    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