Number Transfers

Number Transfers track the progress of requests to transfer a number from another provider

• GET/voip/number-transfer

  Gets a list of all active number transfer 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" : [
          {
              "country_code" : "44",
              "created_on" : "2021-12-04",
              "documents" : [
                  {
                      "document_uuid" : "a21129ab-8168-4c97-b186-b96a047784df",
                      "rejected" : false,
                      "type" : "ownership",
                      "verified" : false
                  }
              ],
              "e164" : "+443301226000",
              "number" : "3301226000",
              "planned_transfer_date" : "1970-01-01",
              "post_code" : "EX4M PL3",
              "status" : "needs_documents",
              "updated_on" : "2021-12-04",
              "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
          }
      ],
      "status_code" : 200,
      "status_message" : "OK"
  }

• GET/voip/number-transfer/{uuid}

  Gets the details for a specific number transfer 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 Number Transfer to be queried

  Response Details

  200 Response

  {
      "result" : {
          "country_code" : "44",
          "created_on" : "2021-12-04",
          "documents" : [
              {
                  "document_uuid" : "a21129ab-8168-4c97-b186-b96a047784df",
                  "rejected" : false,
                  "type" : "ownership",
                  "verified" : false
              }
          ],
          "e164" : "+443301226000",
          "number" : "3301226000",
          "planned_transfer_date" : "1970-01-01",
          "post_code" : "EX4M PL3",
          "status" : "needs_documents",
          "updated_on" : "2021-12-04",
          "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/number-transfer

  Creates a new number transfer request

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  POST body

  • Name

  • Type

  • Required

  • • country_code

    • String

    • True

    The country code of the number to be transferred. We currently only accept UK phone numbers.

  • • number

    • String

    • True

    The number to be transferred, excluding the country code

  • • post_code

    • String

    • True

    The original installation Post Code for this number

  NumberTransferDocument

  • • 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 accepted

  JSON all-fields example:

  {
      "country_code" : "44",
      "number" : "3301226000",
      "post_code" : "EX4M PL3"
  }

  Response Details

  201 Response

  {
      "result" : {
          "country_code" : "44",
          "created_on" : "2021-12-04",
          "documents" : [
              {
                  "document_uuid" : "a21129ab-8168-4c97-b186-b96a047784df",
                  "rejected" : false,
                  "type" : "ownership",
                  "verified" : false
              }
          ],
          "e164" : "+443301226000",
          "number" : "3301226000",
          "planned_transfer_date" : "1970-01-01",
          "post_code" : "EX4M PL3",
          "status" : "needs_documents",
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
      },
      "status_code" : 201,
      "status_message" : "Created"
  }

  400 Response

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

• POST/voip/number-transfer/{uuid}/document

  Links an account document to the number transfer request for verification. Document types required before processing 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 Number Transfer request to be updated

  POST body

  • Name

  • Type

  • Required

  • • country_code

    • String

    • True

    The country code of the number to be transferred. We currently only accept UK phone numbers.

  • • number

    • String

    • True

    The number to be transferred, excluding the country code

  • • post_code

    • String

    • True

    The original installation Post Code for this number

  NumberTransferDocument

  • • 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 accepted

  JSON all-fields example:

  {
      "country_code" : "44",
      "number" : "3301226000",
      "post_code" : "EX4M PL3"
  }

  Response Details

  201 Response

  {
      "result" : {
          "country_code" : "44",
          "created_on" : "2021-12-04",
          "documents" : [
              {
                  "document_uuid" : "a21129ab-8168-4c97-b186-b96a047784df",
                  "rejected" : false,
                  "type" : "ownership",
                  "verified" : false
              }
          ],
          "e164" : "+443301226000",
          "number" : "3301226000",
          "planned_transfer_date" : "1970-01-01",
          "post_code" : "EX4M PL3",
          "status" : "needs_documents",
          "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"
  }

• DELETE/voip/number-transfer/{uuid}

  Deletes the specified number transfer

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the Number Transfer 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"
  }