TicketUserServices

<back to all web services

PhoneVerificationRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin, MobileAppRequires the permission:ReadData
The following routes are available for this service:
POST/phoneverification/request
GET POST/phoneverification/request/{FullPhoneNumber}
GET POST/phoneverification/request/{FullPhoneNumber}/{Path}
PhoneVerificationRequest Parameters:
NameParameterData TypeRequiredDescription
FullPhoneNumberpathstringNo
PathpathstringNo
DeviceIdbodystringNo
OSbodystringNo
RequestUnixUTCTimeStampbodylongNo
SignaturebodyRequestSignatureNo
RequestSignature Parameters:
NameParameterData TypeRequiredDescription
SystemIdformstringNo
SystemSecretformstringNo
SignatureformstringNo
PhoneVerificationRequestResult Parameters:
NameParameterData TypeRequiredDescription
TokenformstringNo
SentSuccessformboolNo
StatusCodeformintNo
StatusMessageformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /phoneverification/request HTTP/1.1 
Host: stubbur-autoupdates-live.smartnewapis.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"fullPhoneNumber":"String","path":"String","deviceId":"String","os":"String","requestUnixUTCTimeStamp":0,"signature":{"systemId":"String","systemSecret":"String","signature":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"token":"String","sentSuccess":false,"statusCode":0,"statusMessage":"String"}