Service
Click here for a complete list of operations.
SendVerificationCode
Send a verification code SMS to the specified phone number.
Arguments:
loginEmail: Login Email of Spread.
apiKey: API KEY of Spread.
request: Send verification code request.
PhoneNumber: Mobile phone number, in E.164 format, such as "+8613800138000".
Channel: Sending channel, default "sms".
CustomFriendlyName: A Custom user defined friendly name that overwrites the existing one In the verification message.
Locale: The SMS language can be selected from the values "en", "zh-HK", and "zh-CN". If left blank, the locale will be automatically resolved based on the phone number country code for SMS.
CustomCode: A pre-generated code To use For verification. The code can be between 4 And 10 characters, inclusive.
TemplateId: Optional, specify the SMS Campaign ID as the SMS template.
CustomSubstitutions: A stringified JSON Object In which the keys are the template's special variables and the values are the variables substitutions.
return sent result (SendVerificationCodeResponse).
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /service.asmx HTTP/1.1
Host: service.rspread.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://service.reasonablespread.com/SendVerificationCode"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SendVerificationCode xmlns="http://service.reasonablespread.com/">
<loginEmail>string</loginEmail>
<apiKey>string</apiKey>
<request>
<PhoneNumber>string</PhoneNumber>
<Channel>string</Channel>
<CustomFriendlyName>string</CustomFriendlyName>
<Locale>string</Locale>
<CustomCode>string</CustomCode>
<TemplateId>string</TemplateId>
<CustomSubstitutions>string</CustomSubstitutions>
</request>
</SendVerificationCode>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SendVerificationCodeResponse xmlns="http://service.reasonablespread.com/">
<SendVerificationCodeResult>
<VerificationId>string</VerificationId>
<Status>string</Status>
<ErrorCode>string</ErrorCode>
<ErrorMessage>string</ErrorMessage>
</SendVerificationCodeResult>
</SendVerificationCodeResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /service.asmx HTTP/1.1
Host: service.rspread.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendVerificationCode xmlns="http://service.reasonablespread.com/">
<loginEmail>string</loginEmail>
<apiKey>string</apiKey>
<request>
<PhoneNumber>string</PhoneNumber>
<Channel>string</Channel>
<CustomFriendlyName>string</CustomFriendlyName>
<Locale>string</Locale>
<CustomCode>string</CustomCode>
<TemplateId>string</TemplateId>
<CustomSubstitutions>string</CustomSubstitutions>
</request>
</SendVerificationCode>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendVerificationCodeResponse xmlns="http://service.reasonablespread.com/">
<SendVerificationCodeResult>
<VerificationId>string</VerificationId>
<Status>string</Status>
<ErrorCode>string</ErrorCode>
<ErrorMessage>string</ErrorMessage>
</SendVerificationCodeResult>
</SendVerificationCodeResponse>
</soap12:Body>
</soap12:Envelope>