Requires any of the roles: | Admin, TeamAdmin, MobileApp | Requires the permission: | ReadData |
POST | /phoneverification/request | ||
---|---|---|---|
GET POST | /phoneverification/request/{FullPhoneNumber} | ||
GET POST | /phoneverification/request/{FullPhoneNumber}/{Path} |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FullPhoneNumber | path | string | No | |
Path | path | string | No | |
DeviceId | body | string | No | |
OS | body | string | No | |
RequestUnixUTCTimeStamp | body | long | No | |
Signature | body | RequestSignature | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SystemId | form | string | No | |
SystemSecret | form | string | No | |
Signature | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Token | form | string | No | |
SentSuccess | form | bool | No | |
StatusCode | form | int | No | |
StatusMessage | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 }