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}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PhoneVerificationRequestResult:
    token: Optional[str] = None
    sent_success: Optional[bool] = None
    status_code: Optional[int] = None
    status_message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RequestSignature:
    system_id: Optional[str] = None
    system_secret: Optional[str] = None
    signature: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PhoneVerificationRequest:
    full_phone_number: Optional[str] = None
    path: Optional[str] = None
    device_id: Optional[str] = None
    os: Optional[str] = None
    request_unix_u_t_c_time_stamp: Optional[int] = None
    signature: Optional[RequestSignature] = None

Python PhoneVerificationRequest DTOs

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 /phoneverification/request HTTP/1.1 
Host: stubbur-autoupdates-live.smartnewapis.com 
Accept: text/jsv
Content-Type: text/jsv
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: text/jsv
Content-Length: length

{
	token: String,
	sentSuccess: False,
	statusCode: 0,
	statusMessage: String
}