Qualified Numbers

You can use the Qualified Numbers API to qualify numbers you want Sinch to host and have available for use with Sinch SMS services. Qualifying a number involves verifying ownership of a number either by providing a one time passcode sent to the number by voice call or by providing invoices for multiple numbers. Once numbers are qualified, you can then enable those numbers for SMS text messaging services.

Note: The SMS enablement process is only supported in United States and Canada.

List qualified numbers

Returns a list of qualified numbers for the project.

SecurityBasic or OAuth2.0
Request
path Parameters
projectId
required
string

Found on your Sinch Customer Dashboard. Settings > Projects.

Example: d1923022-5199-4bb3-a513-c47b3a656bc5
query Parameters
states
required
string

The qualified number states

Enum: "GLOBAL_PROCESS_STATE_ELIGIBLE_CHECK_PENDING" "GLOBAL_PROCESS_STATE_ELIGIBLE" "GLOBAL_PROCESS_STATE_NOT_ELIGIBLE" "GLOBAL_PROCESS_STATE_VERIFICATION_PENDING" "GLOBAL_PROCESS_STATE_VERIFICATION_FAILED" "GLOBAL_PROCESS_STATE_VERIFICATION_BLOCKED" "GLOBAL_PROCESS_STATE_VERIFIED" "GLOBAL_PROCESS_STATE_HOSTING_IN_PROGRESS" "GLOBAL_PROCESS_STATE_HOSTING_DONE" "GLOBAL_PROCESS_STATE_HOSTING_FAILED"
Example: states=GLOBAL_PROCESS_STATE_HOSTING_IN_PROGRESS
regionCode
string

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

Example: regionCode=US
pageSize
integer

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

Example: pageSize=20
pageToken
string

The next page token value returned from a previous listing.

Example: pageToken=C2VNYXJrEg4KDCsxMjAxMjI2MzUyOQ==
orderBy
string

Parameter used to order the returned hosting orders

Responses
200

OK

Response Schema: application/json
Array of objects (QualifiedNumber)
Array
phoneNumber
string

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

projectId
string

The ID of the project to which the number belongs.

regionCode
string
globalProcessState
string <enum>

The global processing state of the qualified number.

Enum: "GLOBAL_PROCESS_STATE_UNSPECIFIED" "GLOBAL_PROCESS_STATE_ELIGIBLE_CHECK_PENDING" "GLOBAL_PROCESS_STATE_ELIGIBLE" "GLOBAL_PROCESS_STATE_NOT_ELIGIBLE" "GLOBAL_PROCESS_STATE_VERIFICATION_PENDING" "GLOBAL_PROCESS_STATE_VERIFICATION_FAILED" "GLOBAL_PROCESS_STATE_VERIFICATION_BLOCKED" "GLOBAL_PROCESS_STATE_VERIFIED" "GLOBAL_PROCESS_STATE_HOSTING_IN_PROGRESS" "GLOBAL_PROCESS_STATE_HOSTING_DONE" "GLOBAL_PROCESS_STATE_HOSTING_FAILED"
object (QualifiedNumber_OsrEligibilityDetails)
object (QualifiedNumber_OwnershipVerificationDetails)
object (QualifiedNumber_HostedNumberDetails)
createdTime
string <date-time>
updatedTime
string <date-time>
nextPageToken
string
totalSize
integer <int32>
404

NOT FOUND: The resource could not be found.

500

INTERNAL: Internal server error. Typically, a server bug.

get/v1/projects/{projectId}/qualifiedNumbers
Request samples 
Response samples 
application/json
{
  • "qualifiedNumbers": [
    • {
      }
    ],
  • "nextPageToken": "string",
  • "totalSize": 0
}
Get qualified number
Return a qualified number as specified by the phone number in the path.


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
Found on your Sinch Customer Dashboard. Settings > Projects.


 
 Example:  d1923022-5199-4bb3-a513-c47b3a656bc5
phoneNumber
required
string
The phone number in E.164 format with leading +.


 
 Example:  +12025550134
Responses 
200
OK


Response Schema: application/json
phoneNumber
string
The phone number in e.164 format with leading +.


 
projectId
string
The ID of the project to which the number belongs.


 
regionCode
string
 
globalProcessState
string <enum> 
The global processing state of the qualified number.


 Enum: "GLOBAL_PROCESS_STATE_UNSPECIFIED" "GLOBAL_PROCESS_STATE_ELIGIBLE_CHECK_PENDING" "GLOBAL_PROCESS_STATE_ELIGIBLE" "GLOBAL_PROCESS_STATE_NOT_ELIGIBLE" "GLOBAL_PROCESS_STATE_VERIFICATION_PENDING" "GLOBAL_PROCESS_STATE_VERIFICATION_FAILED" "GLOBAL_PROCESS_STATE_VERIFICATION_BLOCKED" "GLOBAL_PROCESS_STATE_VERIFIED" "GLOBAL_PROCESS_STATE_HOSTING_IN_PROGRESS" "GLOBAL_PROCESS_STATE_HOSTING_DONE" "GLOBAL_PROCESS_STATE_HOSTING_FAILED"  
object (QualifiedNumber_OsrEligibilityDetails) 
 
status
integer <enum> 
 
error
string
 
object (QualifiedNumber_OwnershipVerificationDetails) 
 
status
integer <enum> 
 
error
string
 
object (QualifiedNumber_HostedNumberDetails) 
 
status
integer <enum> 
The status of the hosting details.


 Enum Value Description
0
HOSTING_STATUS_UNSPECIFIED


1
HOSTING_STATUS_HOSTED


2
HOSTING_STATUS_FAILED


 
error
string
The description of the hosting status error.


 
createdTime
string <date-time> 
 
updatedTime
string <date-time> 
 
404
NOT FOUND: The resource could not be found.


500
INTERNAL: Internal server error. Typically, a server bug.


get/v1/projects/{projectId}/qualifiedNumbers/{phoneNumber}
Request samples 
Response samples 
application/json
{
  • "phoneNumber": "+12025550134",
  • "projectId": "abcd12ef-ab12-ab12-bc34-abcdef123456",
  • "regionCode": "string",
  • "globalProcessState": "GLOBAL_PROCESS_STATE_UNSPECIFIED",
  • "osrEligibility": {
    • "status": 0,
    • "error": "string"
    },
  • "ownershipVerification": {
    • "status": 0,
    • "error": "string"
    },
  • "hostedNumber": {
    • "status": 0,
    • "error": "string"
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z"
}
Delete qualified number
Deletes a qualified number as specified by the phone number in the path.


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
You can find your project ID on dashboard.sinch.com.


 
phoneNumber
required
string
The ID of the number to delete.


 
Responses 
200
OK


404
NOT FOUND: The resource could not be found.


500
INTERNAL: Internal server error. Typically, a server bug.


delete/v1/projects/{projectId}/qualifiedNumbers/{phoneNumber}
Request samples 
Response samples 
application/json
{
  • "code": "404",
  • "message": "The imported number could not be found.",
  • "status": "NOT_FOUND"
}
Create qualified number batch
Create a request to qualify a batch of numbers. After you have submitted the request, you must send an email to orders@sinch.com attaching all of the invoices related to the phone numbers in the request. In most cases, it will take the Sinch team 1-3 days to review your documentation and qualify your numbers.


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
Found on your Sinch Customer Dashboard. Settings > Projects.


 
 Example:  d1923022-5199-4bb3-a513-c47b3a656bc5
Request Body schema: application/json
required
phoneNumbers
required
Array of strings
 
Responses 
200
OK


Response Schema: application/json
Array of objects (QualifiedNumber) 
 
 Array 
phoneNumber
string
The phone number in e.164 format with leading +.


 
projectId
string
The ID of the project to which the number belongs.


 
regionCode
string
 
globalProcessState
string <enum> 
The global processing state of the qualified number.


 Enum: "GLOBAL_PROCESS_STATE_UNSPECIFIED" "GLOBAL_PROCESS_STATE_ELIGIBLE_CHECK_PENDING" "GLOBAL_PROCESS_STATE_ELIGIBLE" "GLOBAL_PROCESS_STATE_NOT_ELIGIBLE" "GLOBAL_PROCESS_STATE_VERIFICATION_PENDING" "GLOBAL_PROCESS_STATE_VERIFICATION_FAILED" "GLOBAL_PROCESS_STATE_VERIFICATION_BLOCKED" "GLOBAL_PROCESS_STATE_VERIFIED" "GLOBAL_PROCESS_STATE_HOSTING_IN_PROGRESS" "GLOBAL_PROCESS_STATE_HOSTING_DONE" "GLOBAL_PROCESS_STATE_HOSTING_FAILED"  
object (QualifiedNumber_OsrEligibilityDetails) 
 
object (QualifiedNumber_OwnershipVerificationDetails) 
 
object (QualifiedNumber_HostedNumberDetails) 
 
createdTime
string <date-time> 
 
updatedTime
string <date-time> 
 
404
NOT FOUND: The resource could not be found.


500
INTERNAL: Internal server error. Typically, a server bug.


post/v1/projects/{projectId}/qualifiedNumbers:addNumbers
Request samples 
application/json
{
  • "phoneNumbers": [
    • "+12345612345"
    ]
}
Response samples 
application/json
{
  • "qualifiedNumbers": [
    • {
      }
    ]
}
Text enable numbers
Enables text capability for the specified qualified numbers. You can enable up to 500 numbers at once. To enable a number for SMS, you must include a Campaign ID and billing information for a Letter of Authorization to be generated. The information required can differ depending on if you are a direct customer of Sinch or a reseller. The Letter of Authorization will be sent to the email you provide in the request to be e-signed.


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
Found on your Sinch Customer Dashboard. Settings > Projects.


 
 Example:  d1923022-5199-4bb3-a513-c47b3a656bc5
Request Body schema: application/json
required
regionCode
required
string
The region code for the hosting order.


 
numbers
required
Array of strings
An array of all the phone numbers associated with the hosting order.


 
servicePlanId
required
string
The ID of the service plan to which the hosting order is associated.


 
projectId
string
The ID of the project to which the hosting order is associated.


 
displayName
string
The optional display name of the hosting order.


 
nnid
string
Defaults to either Sinch NNID or what was originally configured on the customer account. Sinch encourages customers to use the Sinch NNID, but if you want to use another NNID, please contact your account manager.


 
campaignId
string
The ID of the campaign to which the hosting order is associated.


 
object (DirectLoaInfo) 
Letter of Authorization for direct Sinch customers.


 
required
object (AuthorizedPerson) 
The person authorized and responsible for the hosting order.


 
firstName
required
string
The first name of the authorized person.


 
lastName
required
string
The last name of the authorized person.


 
email
required
string
The email address of the authorized person.


 
required
object (Address) 
The address of the business.


 
buildingNumber
required
string
The building number of the address.


 
street
required
string
The street name of the address.


 
city
required
string
The city name of the address.


 
state
required
string
The state name of the address.


 
postalCode
required
string
The postal code of the address.


 
country
required
string
The country of the address.


 
currentVoiceCarrier
required
string
The current carrier you are using for voice services for the number you want to host on Sinch.


 
object (ResellerLoaInfo) 
Letter of Authorization for resellers.


 
businessName
required
string
The name of the business.


 
required
object (AuthorizedPerson) 
The person authorized and responsible for the hosting order.


 
firstName
required
string
The first name of the authorized person.


 
lastName
required
string
The last name of the authorized person.


 
email
required
string
The email address of the authorized person.


 
required
object (Address) 
The address of the business.


 
buildingNumber
required
string
The building number of the address.


 
street
required
string
The street name of the address.


 
city
required
string
The city name of the address.


 
state
required
string
The state name of the address.


 
postalCode
required
string
The postal code of the address.


 
country
required
string
The country of the address.


 
currentVoiceCarrier
required
string
The current carrier you are using for voice services for the number you want to host on Sinch.


 
blanketLoaInfo
object (BlanketLoaInfo) 
You can set up a blanket Letter of Authorization (LoA) that will allow you to import numbers to your account without having to sign an LoA each time you submit a request. To set up a blanket LoA, email your account manager. Once the LoA has been approved, you can use this blanketLoaInfo object in your requests. The blanketLoaInfo object should be sent as an empty object.


 
scheduledOsrUpdateTime
string <date-time> 
 
callbackUrl
string
The client's callback URL to be called for text enablement updates.


 
Responses 
200
OK


Response Schema: application/json
hostingOrderId
string
The ID of the hosting order.


 
404
NOT FOUND: The resource could not be found.


500
INTERNAL: Internal server error. Typically, a server bug.


post/v1/projects/{projectId}/qualifiedNumbers:textEnableNumbers
Request samples 
application/json
{
  • "regionCode": "US",
  • "numbers": [
    • "+12025550134"
    ],
  • "servicePlanId": "YOUR_service_plan_id",
  • "campaignId": "YOUR_campaign_id",
  • "directLoaInfo": {
    • "authorisedPerson": {
      },
    • "address": {
      },
    • "currentVoiceCarrier": "Verizon"
    },
  • "scheduledOsrUpdateTime": "2023-01-13T14:34:40.968Z",
  • "migrateToSinchTmo": true
}
Response samples 
application/json
{
  • "hostingOrderId": "string"
}
Text enable Toll Free qualified numbers
Text enable Toll Free qualified numbers of a specific project by creating a hosting order.


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
Found on your Sinch Customer Dashboard. Settings > Projects.


 
 Example:  d1923022-5199-4bb3-a513-c47b3a656bc5
Request Body schema: application/json
required
The request to text-enable hosting orders Toll Free numbers in the current project


One of:
Request for text enabling project Toll Free numbers.


regionCode
required
string
ISO 3166-1 alpha-2 country code of the phone number. Example: US, CA


 
numbers
required
Array of strings
 
servicePlanId
required
string
The SMS service that the number will be linked to. The servicePlanId can be found in the Sinch Customer Dashboard.


 
required
object (DirectLoaInfo) 
Letter of Authorization for direct Sinch customers.


 
required
object (AuthorizedPerson) 
The person authorized and responsible for the hosting order.


 
firstName
required
string
The first name of the authorized person.


 
lastName
required
string
The last name of the authorized person.


 
email
required
string
The email address of the authorized person.


 
required
object (Address) 
The address of the business.


 
buildingNumber
required
string
The building number of the address.


 
street
required
string
The street name of the address.


 
city
required
string
The city name of the address.


 
state
required
string
The state name of the address.


 
postalCode
required
string
The postal code of the address.


 
country
required
string
The country of the address.


 
currentVoiceCarrier
required
string
The current carrier you are using for voice services for the number you want to host on Sinch.


 
displayName
string
The display name of the numbers.


 
scheduledZipwhipProvisioningTime
string
Optional field which allow to determine when Zipwhip provisioning will be done. Timestamp needs to be from UTC zone. Important! If LOA is signed after scheduledZipwhipProvisioningTime, date will be rescheduled to the next day at the same time.


 
callbackUrl
string
The callback URL to be called for text enablement updates


 
Responses 
200
A successful response with a hosting order, or an error


Response Schema: application/json
projectId
string
The project ID to which the hosting order is associated.


 
hostingOrderId
string
The unique ID of the hosting order.


 
displayName
string
The friendly name of the hosting order.


 
regionCode
string
The region code of the hosting order. Number hosting is only available for the US and Canada, so you must enter either "US" or "CA".


 
state
string
The state of the hosting order.


 Enum: "HOSTING_ORDER_STATE_UNSPECIFIED" "DRAFT" "SUBMITTED" "WAITING_FOR_LOA_SIGNATURE" "IN_PROGRESS" "COMPLETED" "REJECTED"  
type
string
The hosting order type.


 Enum: "HOSTING_ORDER_TYPE_UNSPECIFIED" "IMPORT" "TYPE_TEXT_ENABLE"  
createdTime
string <date-time> 
Timestamp when the hosting order was created


 
updatedTime
string <date-time> 
Timestamp when the hosting order was last updated


 
scheduledOsrUpdateTime
string <date-time> 
Timestamp when the OSR update will be done


 
servicePlanId
string
The service plan to which the hosting order is associated.


 
campaignId
string
The campaign to which the hosting order is associated.


 
migrateToSinchTmo
boolean
Displays if a number is assigned to another aggregator in T-Mobile's platform, and requires migration from previous aggregator to Sinch.


 
object (TextEnableInfo) 
 
businessName
string
The name of the business.


 
object (AuthorizedPerson) 
The person authorized and responsible for the hosting order.


 
firstName
required
string
The first name of the authorized person.


 
lastName
required
string
The last name of the authorized person.


 
email
required
string
The email address of the authorized person.


 
object (Address) 
The address of the business.


 
buildingNumber
required
string
The building number of the address.


 
street
required
string
The street name of the address.


 
city
required
string
The city name of the address.


 
state
required
string
The state name of the address.


 
postalCode
required
string
The postal code of the address.


 
country
required
string
The country of the address.


 
serviceProvider
string
 
currentVoiceCarrier
string
The current carrier you are using for voice services for the number you want to host on Sinch.


 
nnid
string
The Net Number ID for the number you want to host on Sinch.


 
loaType
integer <enum> 
The type of the letter of authorization.


 Enum Value Description
Direct
If you are a direct Sinch customer.


Reseller
If you are a Sinch partner or reseller.


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


 
400
Status returned if any of the projectId, displayName, regionCode, numbers, nnid, servicePlanId or campaignId parameters are not valid


404
The imported number, project, hosting order, qualified number or phone number could not be found


409
The imported number already exists and cannot be created


500
Internal server error. Typically, a server bug.


post/v1/projects/{projectId}/qualifiedNumbers:textEnableTollFreeNumbers
Request samples 
application/json
{
  • "regionCode": "US",
  • "numbers": [
    • "+18335870229",
    • "+18339460473"
    ],
  • "servicePlanId": "07d6c2621f364b68856fe4938b7bb78f",
  • "callbackUrl": "https://www.your-callback-server.com/callback",
  • "directLoaInfo": {
    • "authorisedPerson": {
      },
    • "address": {
      },
    • "currentVoiceCarrier": "Verizon",
    • "scheduledZipwhipProvisioningTime": "2023-01-13T14:34:40.968Z",
    • "migrateToSinchTmo": true
    }
}
Response samples 
application/json
{
  • "projectId": "d1923022-5199-4bb3-a513-c47n7a656bc5",
  • "hostingOrderId": "01arz3nhyrtsv4rrffq69g5fav",
  • "displayName": "Hosting order with campaignId, nnid and smsAppId",
  • "regionCode": "US",
  • "state": "SUBMITTED",
  • "type": "TYPE_TEXT_ENABLE",
  • "createdTime": "2023-01-12T14:34:40.968Z",
  • "updatedTime": "2023-01-12T14:34:40.968Z",
  • "scheduledOsrUpdateTime": "2023-01-13T14:34:40.968Z",
  • "servicePlanId": "16e5c8d2odc842bda9a1b90e1673c174",
  • "campaignId": "C3O84GA",
  • "migrateToSinchTmo": true,
  • "callbackUrl": "https://www.your-callback-server.com/callback",
  • "hostingOrderInfo": {
    • "businessName": "Sinch AB",
    • "authorisedPerson": {
      },
    • "address": {
      },
    • "serviceProvider": "Sinch America Inc.",
    • "currentVoiceCarrier": "Verizon",
    • "nnid": "104029",
    • "loaType": "DIRECT"
    }
}
Verify voice challenge
Uses the code you received from the Send voice challenge operation to verify that you own the phone number.


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
Found on your Sinch Customer Dashboard. Settings > Projects.


 
 Example:  d1923022-5199-4bb3-a513-c47b3a656bc5
phoneNumber
required
string
The phone number in E.164 format with leading +.


 
 Example:  +12025550134
Request Body schema: application/json
required
code
required
string
 
Responses 
200
OK


Response Schema: application/json
phoneNumber
string
The phone number in e.164 format with leading +.


 
projectId
string
The ID of the project to which the number belongs.


 
regionCode
string
 
globalProcessState
string <enum> 
The global processing state of the qualified number.


 Enum: "GLOBAL_PROCESS_STATE_UNSPECIFIED" "GLOBAL_PROCESS_STATE_ELIGIBLE_CHECK_PENDING" "GLOBAL_PROCESS_STATE_ELIGIBLE" "GLOBAL_PROCESS_STATE_NOT_ELIGIBLE" "GLOBAL_PROCESS_STATE_VERIFICATION_PENDING" "GLOBAL_PROCESS_STATE_VERIFICATION_FAILED" "GLOBAL_PROCESS_STATE_VERIFICATION_BLOCKED" "GLOBAL_PROCESS_STATE_VERIFIED" "GLOBAL_PROCESS_STATE_HOSTING_IN_PROGRESS" "GLOBAL_PROCESS_STATE_HOSTING_DONE" "GLOBAL_PROCESS_STATE_HOSTING_FAILED"  
object (QualifiedNumber_OsrEligibilityDetails) 
 
status
integer <enum> 
 
error
string
 
object (QualifiedNumber_OwnershipVerificationDetails) 
 
status
integer <enum> 
 
error
string
 
object (QualifiedNumber_HostedNumberDetails) 
 
status
integer <enum> 
The status of the hosting details.


 Enum Value Description
0
HOSTING_STATUS_UNSPECIFIED


1
HOSTING_STATUS_HOSTED


2
HOSTING_STATUS_FAILED


 
error
string
The description of the hosting status error.


 
createdTime
string <date-time> 
 
updatedTime
string <date-time> 
 
404
NOT FOUND: The resource could not be found.


500
INTERNAL: Internal server error. Typically, a server bug.


post/v1/projects/{projectId}/qualifiedNumbers/{phoneNumber}:verifyVoiceChallenge
Request samples 
application/json
{
  • "code": "1234"
}
Response samples 
application/json
{
  • "phoneNumber": "+12025550134",
  • "projectId": "abcd12ef-ab12-ab12-bc34-abcdef123456",
  • "regionCode": "string",
  • "globalProcessState": "GLOBAL_PROCESS_STATE_UNSPECIFIED",
  • "osrEligibility": {
    • "status": 0,
    • "error": "string"
    },
  • "ownershipVerification": {
    • "status": 0,
    • "error": "string"
    },
  • "hostedNumber": {
    • "status": 0,
    • "error": "string"
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z"
}
Send voice challenge
Sends a voice challenge to the phone number specified in the path to verify that you own the number. The voice call contains a code that you must use to verify the number.


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
Found on your Sinch Customer Dashboard. Settings > Projects.


 
 Example:  d1923022-5199-4bb3-a513-c47b3a656bc5
phoneNumber
required
string
The phone number in E.164 format with leading +.


 
 Example:  +12025550134
Responses 
200
OK


Response Schema: application/json
phoneNumber
string
The phone number in e.164 format with leading +.


 
projectId
string
The ID of the project to which the number belongs.


 
regionCode
string
 
globalProcessState
string <enum> 
The global processing state of the qualified number.


 Enum: "GLOBAL_PROCESS_STATE_UNSPECIFIED" "GLOBAL_PROCESS_STATE_ELIGIBLE_CHECK_PENDING" "GLOBAL_PROCESS_STATE_ELIGIBLE" "GLOBAL_PROCESS_STATE_NOT_ELIGIBLE" "GLOBAL_PROCESS_STATE_VERIFICATION_PENDING" "GLOBAL_PROCESS_STATE_VERIFICATION_FAILED" "GLOBAL_PROCESS_STATE_VERIFICATION_BLOCKED" "GLOBAL_PROCESS_STATE_VERIFIED" "GLOBAL_PROCESS_STATE_HOSTING_IN_PROGRESS" "GLOBAL_PROCESS_STATE_HOSTING_DONE" "GLOBAL_PROCESS_STATE_HOSTING_FAILED"  
object (QualifiedNumber_OsrEligibilityDetails) 
 
status
integer <enum> 
 
error
string
 
object (QualifiedNumber_OwnershipVerificationDetails) 
 
status
integer <enum> 
 
error
string
 
object (QualifiedNumber_HostedNumberDetails) 
 
status
integer <enum> 
The status of the hosting details.


 Enum Value Description
0
HOSTING_STATUS_UNSPECIFIED


1
HOSTING_STATUS_HOSTED


2
HOSTING_STATUS_FAILED


 
error
string
The description of the hosting status error.


 
createdTime
string <date-time> 
 
updatedTime
string <date-time> 
 
404
NOT FOUND: The resource could not be found.


500
INTERNAL: Internal server error. Typically, a server bug.


post/v1/projects/{projectId}/qualifiedNumbers/{phoneNumber}:sendVoiceChallenge
Request samples 
Response samples 
application/json
{
  • "phoneNumber": "+12025550134",
  • "projectId": "abcd12ef-ab12-ab12-bc34-abcdef123456",
  • "regionCode": "string",
  • "globalProcessState": "GLOBAL_PROCESS_STATE_UNSPECIFIED",
  • "osrEligibility": {
    • "status": 0,
    • "error": "string"
    },
  • "ownershipVerification": {
    • "status": 0,
    • "error": "string"
    },
  • "hostedNumber": {
    • "status": 0,
    • "error": "string"
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z"
}
SecurityPrivacyLegal & ComplianceCookie Statement
© 2024 Sinch. All rights reserved.