Mobile SDK

iOS or Android

API Reference - pims.authentication.smscode-modifyPhoneNumber

Edit
Info: Stellantis Mobile SDK is not publicly available.
Component: 📱  Enrollment PSA
Tutorial: check-out Enrollment.
SDK Version: v2.3
API Available since: v2.0
API Last update: v2.0
Plateforme Compatibility: PSA
Security:
  • Authentication: Authentication is required.
Operations:
SET
pims.authentication.smscode - modifyPhoneNumber

This api allows to modify the phone number.

You should use this API after receiving an smsCode from pims.authentication.smscode - phoneNumberCertification.

Input Parameters Object
Param name Description Type Unit/Values Example Required
type

Type of SMS to request, in this case modifyPhoneNumber.

String

modifyPhoneNumber

 		modifyPhoneNumber true
smsCode

SMS code value. See GET pims.authentication.smscode - phoneNumberCertification.

String

n/a

 		true
phoneNumber

Phone number value.

String

phoneNumber

 		0612345678 true
Output Data Object
No outputted data
Error
No errors
Code Example 
1
2
3
4
5
6
7
8
9
10
11

pims.set("pims.authentication.smscode",
  mapOf( /* parameters */  
    Pair("type", "modifyPhoneNumber"),
    Pair("smsCode", " "),
    Pair("phoneNumber", "0612345678")
  ) 
) { message -> when (message["status"] as? String) {
      "SUCCEEDED" -> { }                          // handle succeeded status
      "FAILED" ->    { }                          // handle failed status
  } }

1
2
3
4
5
6
7
8
9
10
11

pims.set(api: "pims.authentication.smscode",
  parameters: [  
    "type": "modifyPhoneNumber",
    "smsCode": " ",
    "phoneNumber": "0612345678"
  ]
  ) { (message) in 
    if message["status"] == "SUCCEEDED"    { }    // handle succeeded status
    else if message["status"] == "FAILED" { }    // handle failed status
  } 

1
2
3
4
5
6

// representation of the `succeeded` dictionary object message as JSON
{
  "transactionId": "953cfefb-bc72",
  "status": "SUCCEEDED",
  "result": { }
}

false

Back to Ref List 2.3

📱 Enrollment PSA  APIs: