Create a Sandbox Phone

POST /phones/simulate/create_sandbox_phone ⇒ { phone }

Creates a new simulated phone in a sandbox workspace. For more information, see Creating a Simulated Phone for a User Identity.

JavaScript

Request

await seam.phones.simulate.createSandboxPhone({
  user_identity_id: "22222222-2222-2222-2222-222222222222",
});

Response

{
  "device_id": "22222222-2222-2222-2222-444444444444",
  "device_type": "android_phone",
  "created_at": "2025-01-01T10:40:00+00:00",
  ...
}

Python

Request

seam.phones.simulate.create_sandbox_phone(
    user_identity_id="22222222-2222-2222-2222-222222222222"
)

Response

Phone(
  device_id='22222222-2222-2222-2222-444444444444',
  device_type='android_phone',
  created_at='2025-01-01T10:40:00+00:00',
  ...
)

Ruby

Request

seam.phones.simulate.create_sandbox_phone(
  user_identity_id: "22222222-2222-2222-2222-222222222222"
)

Response

{
  "device_id" => "22222222-2222-2222-2222-444444444444",
  "device_type" => "android_phone",
  "created_at" => "2025-01-01T10:40:00+00:00",
  ...
}

PHP

Request

<?php
$seam->phones->simulate->create_sandbox_phone(
    user_identity_id: "22222222-2222-2222-2222-222222222222"
);

Response

<?php
[
    "device_id" => "22222222-2222-2222-2222-444444444444",
    "device_type" => "android_phone",
    "created_at" => "2025-01-01T10:40:00+00:00",
    ...
];

Seam CLI

Request

seam phones simulate create-sandbox-phone --user_identity_id "22222222-2222-2222-2222-222222222222"

Response

{
  "device_id": "22222222-2222-2222-2222-444444444444",
  "device_type": "android_phone",
  "created_at": "2025-01-01T10:40:00+00:00",
  ...
}

Go

Request

package main

import api "github.com/seamapi/go"
import phones "github.com/seamapi/go/phones"

func main() {
	client.Phones.Simulate.CreateSandboxPhone(
		context.Background(),
		phones.PhonesSimulateCreateSandboxPhoneRequest{
			UserIdentityId: api.String("22222222-2222-2222-2222-222222222222"),
		},
	)
}

Response

api.Phone{DeviceId: "22222222-2222-2222-2222-444444444444", DeviceType: "android_phone", CreatedAt: "2025-01-01T10:40:00.000Z"}

Authentication Methods

• API key

• Personal access token Must also include the seam-workspace header in the request.

Request Parameters

custom_sdk_installation_id

Type: string Required: No

---

user_identity_id

Type: string Required: Yes

---

phone_metadata

Type: object Required: No

operating_system Format: Enum

Possible enum values:

• android (default)

• ios

os_version Format: String

Default: 10

device_manufacturer Format: String

Default: Samsung

device_model Format: String

Default: Samsung Galaxy S10

---

assa_abloy_metadata

Type: Object Required: No

ble_capability Format: Boolean

Default: true

hce_capability Format: Boolean

Default: false

nfc_capability Format: Boolean

Default: false

application_version Format: String

Default: 1.0.0

seos_applet_version Format: String

Default: 1.0.0

seos_tsm_endpoint_id Format: Number

Default: 1

---

Return Type

phone