Confirming Mobile Number and SMS Subscription
Method Description
Invoked with a POST request. Operation name is set up via Maestra framework. Details of method invocation can be found here.
POST https://api.maestra.io/v3/operations/{synch/asynch operation}?endpointId={unique ID of site/mobile app/etc.}&operation={operation name}&deviceUUID={unique device ID}
Accept: application/xml
Content-Type: application/xml
Authorization: SecretKey {Secret Key, check with the manager if it's mandatory}
<operation>
<customer>
<ids>
<webSiteUserId>{customer ID}</webSiteUserId>
</ids>
</customer>
<smsConfirmation>
<code>{confirmation code}</code>
</smsConfirmation>
</operation>
Sample Operation
POST https://api.maestra.io/v3/operations/sync?endpointId=Maestra&operation=ConfirmMobilePhone
Accept: application/xml
Content-Type: application/xml
Authorization: SecretKey 2a4wVO
<operation>
<customer>
<ids>
<webSiteUserId>42</webSiteUserId>
</ids>
</customer>
<smsConfirmation>
<code>1234567</code>
</smsConfirmation>
</operation>
Response
<result>
<status>Success</status>
<smsConfirmation>
<processingStatus>{confirmation status}</processingStatus>
</smsConfirmation>
</result>
Confirmation status
Description | Operation Status |
---|---|
Mobile phone number and SMS subscription successfully confirmed | SubscriptionAndMobilePhoneConfirmed |
SMS subscription successfully confirmed. Mobile number already confirmed or requires no confirmation | SubscriptionConfirmed |
Mobile number successfully confirmed. SMS subscription already confirmed or requires no confirmation | MobilePhoneConfirmed |
Mobile number already confirmed or requires no confirmation. Subscription already confirmed or requires no confirmation | AlreadyConfirmed |
Incorrect confirmation code | IncorrectConfirmationCode |
If customer can't be found | CustomerNotFound |
Updated about 1 month ago