POST api/AddressBook/sendUserOtp
Request Information
URI Parameters
None.
Body Parameters
SendUserOtpName | Description | Type | Additional information |
---|---|---|---|
OTP | string |
None. |
|
VerificationType | integer |
None. |
|
Phone | string |
None. |
|
Source | string |
None. |
|
Mode | string |
None. |
|
OfflineCustomerId | string |
None. |
|
CountryCode | integer |
None. |
|
CustomerId | integer |
None. |
|
BusinessID | integer |
None. |
|
UserId | integer |
None. |
|
CustomerName | string |
None. |
|
checkDuplicate | integer |
None. |
|
Flag | integer |
None. |
|
isResend | integer |
None. |
|
CustomMessage | string |
None. |
|
details | Object |
None. |
|
docType | string |
None. |
|
MessageType | integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "OTP": "sample string 1", "VerificationType": 2, "Phone": "sample string 3", "Source": "sample string 4", "Mode": "sample string 5", "OfflineCustomerId": "sample string 6", "CountryCode": 7, "CustomerId": 8, "BusinessID": 9, "UserId": 10, "CustomerName": "sample string 11", "checkDuplicate": 12, "Flag": 13, "isResend": 14, "CustomMessage": "sample string 15", "details": {}, "docType": "sample string 17", "MessageType": 18 }
application/xml, text/xml
Sample:
<SendUserOtp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model"> <BusinessID>9</BusinessID> <CountryCode>7</CountryCode> <CustomMessage>sample string 15</CustomMessage> <CustomerId>8</CustomerId> <CustomerName>sample string 11</CustomerName> <Flag>13</Flag> <MessageType>18</MessageType> <Mode>sample string 5</Mode> <OTP>sample string 1</OTP> <OfflineCustomerId>sample string 6</OfflineCustomerId> <Phone>sample string 3</Phone> <Source>sample string 4</Source> <UserId>10</UserId> <VerificationType>2</VerificationType> <checkDuplicate>12</checkDuplicate> <details /> <docType>sample string 17</docType> <isResend>14</isResend> </SendUserOtp>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
VCAPIResponseName | Description | Type | Additional information |
---|---|---|---|
Version | string |
None. |
|
dateTime | string |
None. |
|
StatusCode | integer |
None. |
|
ErrorMessage | string |
None. |
|
Result | Object |
None. |
Response Formats
application/json, text/json
Sample:
{ "Version": "1.0.0", "dateTime": "2025/04/04 03:43:57", "StatusCode": 1, "ErrorMessage": "sample string 2", "Result": {} }
application/xml, text/xml
Sample:
<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model"> <ErrorMessage>sample string 2</ErrorMessage> <Result /> <StatusCode>1</StatusCode> </VCAPIResponse>