Name | Type | Description | Notes |
---|---|---|---|
id | String | The unique ID of the client. | [optional] |
type | ClientType | [optional] | |
status | StatusEnum | The client status. Indicates if the client is able to receive messages or not. Can be pending, inactive, active, or blocked. | [optional] |
integrationId | String | The ID of the integration that the client was created for. Unused for clients of type sdk, as they incorporate multiple integrations. | [optional] |
externalId | String | The ID of the user on an external channel. For example, the user’s phone number for Twilio, or their page-scoped user ID for Facebook Messenger. Applies only to non-SDK clients. | [optional] |
lastSeen | String | A datetime string with the format `YYYY-MM-DDThh:mm:ss.SSSZ` representing the last time the user interacted with this client. | [optional] |
linkedAt | String | A timestamp signifying when the client was added to the user. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] |
displayName | String | The user's display name on the channel. | [optional] |
avatarUrl | URI | The URL for the user's avatar on the channel. | [optional] |
info | Object | A flat curated object with properties that vary for each client platform. All keys are optional and not guaranteed to be available. | [optional] |
raw | Object | An object with raw properties that vary for each client platform. All keys are optional and not guaranteed to be available. | [optional] |
Name | Value |
---|---|
ACTIVE | "active" |
BLOCKED | "blocked" |
INACTIVE | "inactive" |
PENDING | "pending" |