Caller IDs

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

• 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" : [
          {
              "cli_display" : "+443301226020",
              "cli_name" : "Mobile",
              "created_on" : "2023-03-30",
              "number" : "+443301226020",
              "updated_on" : "2023-03-30",
              "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
          }
      ],
      "status_code" : 200,
      "status_message" : "OK"
  }

• GET/voip/caller-id/{uuid}

  Updates 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" : {
          "cli_display" : "+443301226020",
          "cli_name" : "Mobile",
          "created_on" : "2023-03-30",
          "number" : "+443301226020",
          "updated_on" : "2023-03-30",
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
      },
      "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"
  }