Sign in
latestOpenAPI 3.0.3MIT2026-08-102357127.0 KB

c3d50cf4681d

Imported Numbers

List imported numbers

Lists all imported numbers for the project.

get/v1/projects/{projectId}/importedNumbers

Path parameters

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

Found on your Sinch Customer Dashboard. Settings > Projects.

Query parameters

regionCodestring
Example:US

Region code to filter by. ISO 3166-1 alpha-2 country code of the phone number. Currently supported are US, CA

numberPattern.patternstring
Example:+1732

Sequence of digits to search for. If you prefer or need certain digits in sequential order, you can enter the sequence of numbers here. When using START, a plus sign (+) must be included and URL encoded. For example, to search for area code 206 in the US, the url encoded string would be %2B1206

numberPattern.searchPattern'START' | 'CONTAIN' | 'END'
Example:START

Search pattern to apply. The options are, START, CONTAIN, and END. Numbers that begin with the numberPattern.pattern entered. Often used to search for a specific area code.

pageSizeinteger
Example:20

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

pageTokenstring
Example:C2VNYXJrEg4KDCsxMjAxMjI2MzUyOQ==

The next page token value returned from a previous listing.

orderBy'createdTime' | 'updatedTime'

Parameter used to order the returned hosting orders

servicePlanIdstring required
Example:324e4567-e89b-12d3-a456-426614174000

The hosting order servicePlanId

campaignIdstring required
Example:123e4567-e89b-12d3-a456-426614174000

The hosting order campaignId

Response

OK

nextPageTokenstring

The token to be used for listing the next page.

totalSizeinteger

https://cloud.google.com/apis/design/design_patterns#list_pagination

Example response

{
  "importedNumbers": [
    {
      "phoneNumber": "+12025550134",
      "projectId": "YOUR_project_id",
      "regionCode": "US",
      "displayName": "MyPhoneNumber",
      "smsConfiguration": {
        "servicePlanId": "YOUR_service_plan_id",
        "scheduledProvisioning": {
          "servicePlanId": "YOUR_service_plan_id",
          "campaignId": "YOUR_campaign_id"
        },
        "campaignId": "YOUR_campaign_id"
      },
      "callbackUrl": "https://www.your-callback-server.com/callback",
      "mnoConfiguration": {
        "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"
        }
      },
      "smsProvisioning": {
        "serviceId": "0130a21c9ed6461ba3a1fefda83f7ec7",
        "state": "DONE",
        "updateTime": "2023-02-02T21:00:07.467353Z"
      },
      "campaignProvisioning": {
        "serviceId": "CDCQLGJ",
        "state": "DONE",
        "updateTime": "2023-02-02T21:00:07.467353Z"
      }
    }
  ]
}