SIsinch
Hosting Orders

List hosting order numbers

Lists the numbers belonging to the specified hosting order.

get/v1/projects/{projectId}/hostingOrders/{hostingOrderId}/numbers

Request

  • Base URL
    https://imported.numbers.api.sinch.com
  • URL
    https://imported.numbers.api.sinch.com/v1/projects/{projectId}/hostingOrders/{hostingOrderId}/numbers
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://auth.sinch.com/oauth2/token

Path parameters

projectIdstring required
Example:d1923022-5199-4bb3-a513-c47b3a656bc5

Found on your Sinch Customer Dashboard. Settings > Projects.

hostingOrderIdstring required
Example:01arz3ndektsv4rrffq69g5fav

Found on your Sinch Customer Dashboard. Settings > Projects.

Query parameters

orderBy'createdTime' | 'updatedTime'

Parameter used to order the returned hosting orders

pageTokenstring
Example:C2VNYXJrEg4KDCsxMjAxMjI2MzUyOQ==

The next page token value returned from a previous listing.

pageSizeinteger
Example:20

The maximum number of items to return, server can enforce an upper limit and overwrite the value.

osrUpdateState'DONE' | 'FAILED' | 'IN_PROGRESS' | 'WAITING' | 'STATE_UNSPECIFIED'

Indicates the current state of the operation.

Example:DONE

Filter the results by the state of the OSR update.

campaignProvisioningState'DONE' | 'FAILED' | 'IN_PROGRESS' | 'WAITING' | 'STATE_UNSPECIFIED'

Indicates the current state of the operation.

Example:DONE

Filter the results by the state of the campaign provisioning.

platformProvisioningState'DONE' | 'FAILED' | 'IN_PROGRESS' | 'WAITING' | 'STATE_UNSPECIFIED'

Indicates the current state of the operation.

Example:DONE

Filter the results by the state of the platform provisioning.

Response

OK

nextPageTokenstring
totalSizeinteger

Example response

{
  "numbers": [
    {
      "projectId": "YOUR_project_id",
      "hostingOrderId": "YOUR_hosting_order_id",
      "phoneNumber": "+12025550134",
      "osrUpdate": {
        "state": "DONE"
      },
      "campaignProvisioning": {
        "campaignId": "YOUR_campaign_id",
        "state": "DONE"
      },
      "platformProvisioning": {
        "servicePlanId": "YOUR_service_plan_id",
        "state": "DONE"
      },
      "smsAtt": {
        "state": "DONE",
        "updateTime": "2025-04-02T19:45:28.650924Z"
      },
      "smsTmo": {
        "state": "DONE",
        "updateTime": "2025-04-02T19:45:28.650924Z"
      },
      "mmsAtt": {
        "state": "DONE",
        "updateTime": "2025-04-02T19:45:28.650924Z"
      },
      "mmsTmo": {
        "state": "DONE",
        "updateTime": "2025-04-02T19:45:28.650924Z"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.