Yay.com loading

Loading

Error Sorry

0

Shopping Basket

Basket Total

$0.00

incVAT

Delete everything from your basket?

Go to Checkout

Bundle

A VoIP Bundle is a collection of SIP Users and Phone numbers that represent the customers monthly subscription. A VoIP Bundle must be created before any SIP users or numbers can be created

Become a Reseller

Filter:

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

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

  • Chargeable *

    POST/voip/bundle

    Create a new VoIP Bundle (subscription) for the target customer, the bundle type will change the features available for the customer

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

      • auto_renew

      • Boolean

      • False

      Should this bundle be auto-renewed, will default to false if omitted

      • bundle_type

      • Integer

      • True

      The type of bundle to create, valid values are 1 - Business, 2 - Residential, 3 - Fax Only, 4 - Trunk Only, 5 - Forward Only

    JSON all-fields example:

    {
        "auto_renew" : true,
        "bundle_type" : 1
    }

    Response Details

    201 Response

    {
        "result" : {
            "auto_renew" : true,
            "bundle_type" : 1,
            "expires_on" : "2018-09-01",
            "uuid" : "0fba8c48-99fc-4727-8ca7-c847376da415"
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }
  • Chargeable *

    PUT/voip/bundle/{uuid}

    Updates an existing VoIP Bundle

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the bundle to be upated

    PUT body

    • Name

    • Type

    • Required

      • auto_renew

      • Boolean

      • False

      Should this bundle be auto-renewed, will default to false if omitted

      • bundle_type

      • Integer

      • True

      The type of bundle to create, valid values are 1 - Business, 2 - Residential, 3 - Fax Only, 4 - Trunk Only, 5 - Forward Only

    JSON all-fields example:

    {
        "auto_renew" : true,
        "bundle_type" : 1
    }

    Response Details

    200 Response

    {
        "result" : {
            "auto_renew" : true,
            "bundle_type" : 1,
            "expires_on" : "2018-09-01",
            "uuid" : "0fba8c48-99fc-4727-8ca7-c847376da415"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    400 Response

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

    402 Response

    {
        "result" : {},
        "status_code" : 402,
        "status_message" : "Payment Required"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • Chargeable *

    PUT/voip/bundle/{uuid}/renew

    Renews an existing VoIP Bundle, this can be done up to 3 days before the expiry date, and up to 5 days following

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the bundle to renew

    Response Details

    200 Response

    {
        "result" : {
            "auto_renew" : true,
            "bundle_type" : 1,
            "expires_on" : "2018-09-01",
            "uuid" : "0fba8c48-99fc-4727-8ca7-c847376da415"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    400 Response

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

    402 Response

    {
        "result" : {},
        "status_code" : 402,
        "status_message" : "Payment Required"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
ISO 27001 Business Continuity Accreditation ISO 22301 Business Continuity Accreditation Cyber Essentials Certificate of Assurance G-Cloud accredited by the Crown Commercial Service