Verifying SMS Details
Description
This web service is used to verify the SMS details.
Definition
POST https://<domain>/services/apexrest/peer/v1/sms/verifySms
Parameters
The table given below provides details of the request parameters used by this web service:
Fields | Type | Description |
---|---|---|
accountId* | String | This is the ID of the user account |
sms_Unique_Id* | String | This is the unique SMS code given to the user |
sms_Token* | String | This is the unique token associated with the SMS code |
Error messages
When you post a web service, you can receive the possible error messages as shown in the table below:
Error code | Reason | HTTP Status Code |
---|---|---|
smsService.smsErrorCode | You will receive this error if the account ID, SMS token and the Unique ID is incorrect | 400 |
HTTP_INTERNAL_ERRROR | You will receive this error if there is any run time exception | 500 |
Sample Request
The sample request to be sent is as shown below:
https://na11.salesforce.com/services/apexrest/peer/v1/sms/verifySms
{ "accountId":"01G000001Phdoe", "sms_Unique_Id":"a3ZG00000009z2FMAQ", "sms_Token":"5555"}
Sample Response
The sample response that you will receive is as shown below:
{ "status":"SUCCESS", "response":[ ], "errorCode":"NO_ERROR", "content":[ ] }