RHP_API

<back to all web services

ValidatePhoneNumber

Validates the sent phone number

Requires Authentication
The following routes are available for this service:
POST/User/Phone/Validate
ValidatePhoneNumber Parameters:
NameParameterData TypeRequiredDescription
PhoneNumberbodystringNoThe phone number, can start with a '0'
PhoneAlpha2CodebodystringNo2 character country code eg. AU, VN
PhoneCountryCodebodystringNoThe countries phone code, the starting '+' is optional. eg. AU=+61, US=+1
GenericResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ResultformTNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /User/Phone/Validate HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"PhoneNumber":"String","PhoneAlpha2Code":"String","PhoneCountryCode":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Result":false}