Phone Call Packs

Call Packs allow call minutes to be included at a fixed cost

• GET/voip/call-pack

  Gets all active call packs 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" : [
          {
              "created_on" : "2023-06-07",
              "updated_on" : "2023-06-07",
              "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
          }
      ],
      "status_code" : 200,
      "status_message" : "OK"
  }

• GET/voip/call-pack/{uuid}

  Gets the details for a specific call pack

  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 Pack to query

  Response Details

  200 Response

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

  404 Response

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

• Chargeable *

  POST/voip/call-pack

  Creates a call pack for an account

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  POST body

  • Name

  • Type

  • Required

  • • pack_id

    • int

    • True

    The ID of the Call Pack Type you wish to create. The current available call packs are as follows:
    13: UK Landline & Mobile 1000
    14: UK Landline & Mobile 2000
    15: UK Landline & Mobile 5000
    16: UK Landline & Mobile 10000
    17: UK + EU Landline & Mobile 1000
    18: UK + EU Landline & Mobile 2000
    19: UK + EU Landline & Mobile 5000
    20: UK + EU Landline & Mobile 10000

  JSON all-fields example:

  {
      "pack_id" : 20
  }

  Response Details

  201 Response

  {
      "result" : {
          "created_on" : "2023-06-07",
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
      },
      "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"
  }

• Chargeable *

  PUT/voip/call-pack/{uuid}/renew

  Renews a call pack

  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 Pack to be renewed

  Response Details

  200 Response

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

  404 Response

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

• DELETE/voip/call-pack/{uuid}

  Deletes the specified call pack 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 Call Pack 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"
  }