API REFERENCE GUIDE

USER PROFILE  mobile_define

api description

purpose

In order to register a mobile phone number for a subscriber profile, mobile_define sends to a phone number a short message (SMS) that contains a random code.

Mobile phone numbers are useful in many use cases. One of them is SMS-mailing as proposed in AuverCloud Studio.

The mobile phone registration is completed when that code is confirmed with the API mobile_confirm.

mobile_define requires valid session parameters: uuid, usid, udid and eost. See signin for further details.

PLEASE NOTE:

  • If the mobile number is wrong or does not exist, mobile_define does not return any error. In that case the message is just lost. The sending cost is applied in any case.
  • mobile_define call be called as many times as necessary to update an already confirmed number.

http method: POST

call cost: 1,000 points

See the pricing section for more details.

mandatory parameter(s)

parameter values / comments
api"mobile_define"
key E.g. "c54e7837e0cd0ced286cb5995327d1ab54e35987179b2". It is an application key generated by AuverCloud Studio.
uuidUnique User ID.
usidUnique Session ID.
udidUnique Device ID.
eostEnd of Session Time.
telA valid international mobile phone number without any additional sign e.g. "33789123456" or "15555555555".

optional parameters(s)

parameter values / comments
msgA customized short message (150 characters max.) including the string "%code%" that will be replaced by a random 6-characters code. The default value is "Code to confirm your mobile phone number on AuverCloud: %code%".

call sample

This example is the code used in the test case below. It assumes that jQuery and the JavaScript AuverCloud runtime client are loaded in order to use the arc.api() method. See the API client section for more details.


							

errors

code message comments
660 SMS error(s). This occurs when the SMS service fails for any reason (wrong number, service unavailable...).

See also the Common errors section.

test bed

Call

To test the API with your own keys, please see the section Application keys in AuverCloud Studio.

api
mobile_define
key
tel
msg
 send
request
 clear
response
Response
code
msg
data

discussion