Cdn API - CPG Source

<back to all web services

SmsVerificationSetupRequest

Cdn.Api

The following routes are available for this service:
POST/SmsVerificationSetupRequest
SmsVerificationSetupRequest Parameters:
NameParameterData TypeRequiredDescription
CustomerIdbodylongNo
PhoneNumberbodystringNo
IpAddressbodystringNo
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
SmsVerificationSetupResponse Parameters:
NameParameterData TypeRequiredDescription
ChallengeTokenformGuidNo
MaskedPhoneNumberformstringNo
ExpiresAtformDateTimeNo
SmsRemainingThisHourformintNo
SmsRemainingTodayformintNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
SmsVerificationSetupResponse Parameters:
NameParameterData TypeRequiredDescription
ChallengeTokenformGuidNo
MaskedPhoneNumberformstringNo
ExpiresAtformDateTimeNo
SmsRemainingThisHourformintNo
SmsRemainingTodayformintNo

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 /SmsVerificationSetupRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CustomerId":0,"PhoneNumber":"String","IpAddress":"String","Id":0,"OrderBy":["String"],"OrderDirections":["Asc"]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ChallengeToken":"00000000000000000000000000000000","MaskedPhoneNumber":"String","ExpiresAt":"\/Date(-62135596800000-0000)\/","SmsRemainingThisHour":0,"SmsRemainingToday":0,"Total":0,"OpCode":0,"ErrorText":"String","RequestTime":"String","ResponseTime":"String","TotalExecutionTime":"String","CachedResponse":false}