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}

export class PhoneVerificationRequestResult
{
    public token?: string;
    public sentSuccess?: boolean;
    public statusCode?: number;
    public statusMessage?: string;

    public constructor(init?: Partial<PhoneVerificationRequestResult>) { (Object as any).assign(this, init); }
}

export class RequestSignature
{
    public systemId?: string;
    public systemSecret?: string;
    public signature?: string;

    public constructor(init?: Partial<RequestSignature>) { (Object as any).assign(this, init); }
}

export class PhoneVerificationRequest
{
    public fullPhoneNumber?: string;
    public path?: string;
    public deviceId?: string;
    public os?: string;
    public requestUnixUTCTimeStamp?: number;
    public signature?: RequestSignature;

    public constructor(init?: Partial<PhoneVerificationRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
}