RHP_API

<back to all web services

UpdateUserPhone

Updates the user's phone number and sends an SMS containing a verification code. Currently verification is only available in AU & US

Requires Authentication
The following routes are available for this service:
POST/User/Phone
UserPhoneBasic Parameters:
NameParameterData TypeRequiredDescription
PhoneNumberformstringNoThe phone number, can start with a '0'
IsVisibleformboolNoIf true the user's phone number will be displayed on their profile
IsSmsOnlyformboolNoIf true a note will be added to the user's open profile next to the phone number.
PhoneAlpha2CodeformstringNo2 character country code eg. AU, VN
PhoneCountryCodeformstringNoThe countries phone code, the starting '+' is optional. eg. AU=+61, US=+1
UserPhone Parameters:
NameParameterData TypeRequiredDescription
IsVerifiedformboolNoIf true the user's phone number has been verified.
UserCountryformstringNoThe user's profile Country.
UserCountryCodeformstringNoThe user's profile Country Code.

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

HTTP + JSV

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

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

{
	PhoneNumber: String,
	IsVisible: False,
	IsSmsOnly: False,
	PhoneAlpha2Code: String,
	PhoneCountryCode: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	IsVerified: False,
	UserCountry: String,
	UserCountryCode: String,
	PhoneNumber: String,
	IsVisible: False,
	IsSmsOnly: False,
	PhoneAlpha2Code: String,
	PhoneCountryCode: String
}