Phones

phone

Represents an app user's mobile phone.

device_id

Format: ID

ID of the phone.

---

device_type

Format: Enum

Type of phone.

Possible enum values:

• android_phone

• ios_phone

---

nickname

Format: String

Optional nickname to describe the phone, settable through Seam.

---

display_name

Format: String

Display name of the phone. Defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.

---

properties

Format: Object

assa_abloy_credential_service_metadata Format: Object

• has_active_endpoint Format: Boolean

• endpoints Format: array

  • endpoint_id Format: String

  • is_active Format: Boolean

---

workspace_id

Format: ID

ID of the workspace that contains the phone.

---

errors

Format: List

Errors associated with the phone.

---

warnings

Format: List

Warnings associated with the phone.

---

created_at

Format: Datetime

Date and time at which the phone was created.

---

custom_metadata

Format: Object

Optional custom metadata for the phone.

---

Endpoints

/phones/get

Returns a specified phone.

/phones/list

Returns a list of all phones.

/phones/simulate/create_sandbox_phone

Creates a simulated phone in a sandbox workspace.

/phones/deactivate

Deactivates a phone.