Get imported number

Request

Returns the imported number you specify in the path.

Security

Basic or OAuth2.0

Path

projectIdstringrequired

Found on your Sinch Customer Dashboard. Settings > Projects.

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

phoneNumberstringrequired

The phone number in E.164 format with leading +.

Example:+12025550134

curl -i -X GET \
  -u '<username>:<password>' \
  'https://imported.numbers.api.sinch.com/v1/projects/d1923022-5199-4bb3-a513-c47b3a656bc5/importedNumbers/+12025550134'

Responses

OK

Bodyapplication/json

phoneNumberstring

The phone number in e.164 format with leading +.

Example:"+12025550134"

projectIdstring

The ID of the project resource. You can find your project ID on dashboard.sinch.com.

Example:"YOUR_project_id"

regionCodestring

ISO 3166-1 alpha-2 country code of the phone number. Example US, UK or SE.

Example:"US"

displayNamestring

User supplied name for the phone number.

Example:"MyPhoneNumber"

smsConfigurationobject(SmsConfiguration)

Configuration for SMS

callbackUrlstring

The client's callback URL to be called upon finishing the number import.

Example:"https://www.your-callback-server.com/callback"

mnoConfigurationobject

The mnoConfiguration object represents the status and progress of configuration operations for SMS and MMS services across different carriers (AT&T and T-Mobile). Each key within this object (smsAtt, smsTmo, mmsAtt and mmsTmo) corresponds to a specific service type (SMS or MMS) associated with a particular mobile network operator.

smsProvisioningobject

An object giving details about the SMS provisioning of the number.

campaignProvisioningobject

An object giving details about the campaign provisioning of the number.

Response

{
  "phoneNumber": "+12025550134",
  "projectId": "YOUR_project_id",
  "regionCode": "US",
  "displayName": "MyPhoneNumber",
  "smsConfiguration": {
    "servicePlanId": "YOUR_service_plan_id",
    "scheduledProvisioning": { … },
    "campaignId": "YOUR_campaign_id",
    "migrateToSinchTmo": true
  },
  "callbackUrl": "https://www.your-callback-server.com/callback",
  "mnoConfiguration": {
    "smsAtt": { … },
    "smsTmo": { … },
    "mmsAtt": { … },
    "mmsTmo": { … }
  },
  "smsProvisioning": {
    "serviceType": "SMS",
    "serviceId": "0130a21c9ed6461ba3a1fefda83f7ec7",
    "type": "PROVISIONING",
    "state": "DONE",
    "updateTime": "2023-02-02T21:00:07.467353Z",
    "errorMessage": "",
    "errorCode": ""
  },
  "campaignProvisioning": {
    "serviceType": "SMS",
    "serviceId": "CDCQLGJ",
    "type": "PROVISIONING",
    "state": "DONE",
    "updateTime": "2023-02-02T21:00:07.467353Z",
    "errorMessage": "",
    "errorCode": ""
  }
}

We'd love to hear from you!