/
session_password_set()

session_password_set()

Owned by Alexey Kapitula (Unlicensed)
Function prototype

session_password_set( session, id, secret, new_password, [country_code] )

API VersionAll
Supported interfacesSOAP, REST (from API Version 2.7.32)

Modifies the password of the session's user (or optionally the user identified by user_id)

Input

parameters:

  • session: is the session id obtained in the session_init call
  • id: login of user. Only necessary if session is not provided. When using a phone number as user_id, it must be preceded by the country prefix, unless the parameter country_code is also provided
  • secret: can be any of the following
    • A string with the old password
    • A secret key generated by session_init () when the password has expired (only in API versions 2.7.9.1 and higher)
  • new_password: new password to set for user. The password format must comply with the requirements set in the instance configuration (see WEB SERVICES CONFIGURATION)
  • country_code: (optional) 2-letter ISO Country Code. If provided, the id can be a phone number without the prefix (the country prefix can be deduced from the country code). Introduced in API Version 2.7.24

Output

parameters:

  • result: empty
  • ErrorMsg: If any error occurs, then this value contains a description of the error translated to the current language
  • ErrorCode: If any error occurs, then this value contains any of the standard ERROR CODES

Request

sample:

session_password_set( “LCAAAAAAAAAAA”, ”1”, "myoldpassword", "mynewpassword");

Response

sample:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<result></result>
<ErrorMsg></ErrorMsg>
<ErrorCode></ErrorCode>

Notes:


Related content