Sending SMS Verification Details

  • Updated

Sending SMS Verification Details

Description

This web service is used to set and send SMS verification details.

A unique ID is sent to the user if the request is successful , otherwise it is set to null.

Definition

GET https://<domain>/services/apexrest/peer/v1/sms/sendSms

Parameters 

The table given below provides details of the request parameters used by this web service:

FieldsTypeDescription
accountId*String

This is the ID of the user account

sms_Code*

StringThis is the unique SMS code given to the user
phoneString
  • This is the phone number of the user. 
  • If the phone number is not provided, then the number stored with this account is used
typeString
  • This is the type of phone number or authentication provided.
  • By default, the authentication takes place via SMS.               

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

Sms Verification DisabledYou will receive this error if the SMS verification is disabled
and the coverage is not present 

400

No phone with your accountYou will receive this error if the requested phone number is not found in the records

400

ACCOUNT_NOT_FOUNDYou will receive this error if the account is not found in the records

400

Maximum SMS limit reachedYou will receive this error if you have reached the maximum SMS limit
on a given day 

401

Sms send failed.Please try againYou will receive this error if the message that you are trying to send has failed

401

NO_PARAMS_SMSYou will receive this error if the SMS token, SMS unique ID required to send an SMS are not present.

401

INCORRECT_SMSYou will receive this error if the incorrect SMS token is entered

401

MAX_RETRY_SMSYou will receive this error if you reach the maximum limit to enter the SMS token

401

INCORRECT_SMSYou will receive this error if you enter the incorrect SMS token

401

TIMEOUT_SMSYou will receive this error if the SMS token is entered after a certain period of time. ie., after the time-out of the SMS token.

401

HTTP_INTERNAL_ERRRORYou 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/sendSms?accountId=001G000001Phdoe&sms_Code=5555

Sample Response

The sample response that you will receive is as shown below:

{
   "status":"SUCCESS",
   "response":[
      {
         "smsUniqueId":"a3ZG00000009z2FMAQ"      }
   ],
   "errorCode":"NO_ERROR",
   "content":[

   ]
}

In This Article