Verify voice challenge

Numbers/

Request

Uses the code you received from the Send voice challenge operation to verify that you own the phone number.

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

Bodyapplication/jsonrequired

codestringrequired

Example:"1234"

library(httr)

body = '{
   "code": "1234"
}'

project_id = "d1923022-5199-4bb3-a513-c47b3a656bc5"
phone_number = "+12025550134"

# create you own operator
"%&%" <- function(x, y)paste0(x,y)

url = "https://imported.numbers.api.sinch.com/v1/projects/" %&% project_id %&% "/qualifiedNumbers/" %&% phone_number %&% ":verifyVoiceChallenge"

data_req <- POST(
  url,
  authenticate("<username>", "<password>")
  add_headers("Content-Type" = "application/json"),
  body = body,
  encode = "json",
  verbose()
)

content(data_req)

Responses

Bodyapplication/json

phoneNumberstring

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

Example:"+12025550134"

projectIdstring

The ID of the project to which the number belongs.

Example:"abcd12ef-ab12-ab12-bc34-abcdef123456"

regionCodestring

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

Example:"US"

globalProcessStatestring, (enum)

The global processing state of the qualified number.

Enum Value	Description
GLOBAL_PROCESS_STATE_UNSPECIFIED	The state is unspecified.
GLOBAL_PROCESS_STATE_ELIGIBLE_CHECK_PENDING	The check for eligibility is pending.
GLOBAL_PROCESS_STATE_ELIGIBLE	The state is eligible.
GLOBAL_PROCESS_STATE_NOT_ELIGIBLE	The state is not eligible.
GLOBAL_PROCESS_STATE_VERIFICATION_PENDING	The state verification is pending.
GLOBAL_PROCESS_STATE_VERIFICATION_FAILED	The state verification failed.
GLOBAL_PROCESS_STATE_VERIFICATION_BLOCKED	The state verification is blocked.
GLOBAL_PROCESS_STATE_VERIFIED	The state is verified.
GLOBAL_PROCESS_STATE_HOSTING_IN_PROGRESS	Hosting process is in progress.
GLOBAL_PROCESS_STATE_HOSTING_DONE	Hosting process is done.
GLOBAL_PROCESS_STATE_HOSTING_FAILED	Hosting process failed.

osrEligibilityobject(QualifiedNumber_OsrEligibilityDetails)

Details about the OSR eligibility, including the status of the OSR update, and the error if available.

ownershipVerificationobject(QualifiedNumber_OwnershipVerificationDetails)

Details about the ownership verification, including the status of the verification process and any error if available.

hostedNumberobject(QualifiedNumber_HostedNumberDetails)

Details about the hosting status of a number, including any errors if available.

createdTimestring, (date-time)

The date and time the hosting order was created.

updatedTimestring, (date-time)

The date and time the hosting order was last updated.

Response

{
  "phoneNumber": "+12025550134",
  "projectId": "abcd12ef-ab12-ab12-bc34-abcdef123456",
  "regionCode": "US",
  "globalProcessState": "GLOBAL_PROCESS_STATE_UNSPECIFIED",
  "osrEligibility": {
    "status": "DONE",
    "error": "string"
  },
  "ownershipVerification": {
    "status": "DONE",
    "error": "string"
  },
  "hostedNumber": {
    "status": 0,
    "error": "string"
  },
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z"
}