> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.vlenseg.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.vlenseg.com/_mcp/server.

# Get change-phone session settings

GET https://api.vlenseg.com/api/ChangePhoneNumberSession/GetUserSessionSettings

Returns the settings of the active change-phone-number session. Called by the embedded Vlens UI.

Reference: https://docs.vlenseg.com/api-reference/vlens-api/change-phone-number-session/get-change-phone-number-session-get-user-session-settings

## Authentication

- `ApiKey` header (required) — Static API key issued to your tenant. Required on every request.

## Servers

- `https://api.vlenseg.com` (Production, default)
- `https://api.vlens.co` (Staging)

## Response

### 200

Session settings.

- `sessionId` (string, optional)
- `returnUrl` (string, optional, nullable)
- `newPhoneNumber` (string, optional, nullable)
- `sessionStartingPath` (string, optional, nullable)

## Examples

**Response**

```json
{
  "sessionId": "string",
  "returnUrl": "string",
  "newPhoneNumber": "string",
  "sessionStartingPath": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.vlenseg.com/api/ChangePhoneNumberSession/GetUserSessionSettings"

headers = {"ApiKey": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.vlenseg.com/api/ChangePhoneNumberSession/GetUserSessionSettings';
const options = {method: 'GET', headers: {ApiKey: '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vlenseg.com/api/ChangePhoneNumberSession/GetUserSessionSettings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("ApiKey", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.vlenseg.com/api/ChangePhoneNumberSession/GetUserSessionSettings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["ApiKey"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.vlenseg.com/api/ChangePhoneNumberSession/GetUserSessionSettings")
  .header("ApiKey", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.vlenseg.com/api/ChangePhoneNumberSession/GetUserSessionSettings', [
  'headers' => [
    'ApiKey' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.vlenseg.com/api/ChangePhoneNumberSession/GetUserSessionSettings");
var request = new RestRequest(Method.GET);
request.AddHeader("ApiKey", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["ApiKey": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.vlenseg.com/api/ChangePhoneNumberSession/GetUserSessionSettings")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```