Aller au contenu
Livstick Développeurs
v3 Demander un accès

Schémas

API v3

ApiError Aucune propriété supplémentaire acceptée

Nom Type Requis Description
code string Requis
message string Requis

ApiErrorEnvelope Aucune propriété supplémentaire acceptée

Nom Type Requis Description
error ApiError Requis

CodeGroupListItem

Nom Type Requis Description
objectId string Requis
name string Requis
publicId string Facultatif
status integer Requis
createdAt string Requis Contraintes format date-time

CodeGroupListResponse

Nom Type Requis Description
items array of CodeGroupListItem Requis
total integer Requis
limit integer Requis
skip integer Requis

ContainerDetails Aucune propriété supplémentaire acceptée

Nom Type Requis Description
crid string Requis
urid string Requis
state ContainerState Requis Valeurs recording_open recording_closed
mode ContainerMode Requis Valeurs single gallery
shipped boolean Facultatif
message MessageInfo Facultatif

ContainerLinks Aucune propriété supplémentaire acceptée

Nom Type Requis Description
recordingUrl string Requis Contraintes format uri
previewUrl string Requis Contraintes format uri

ContainerListItem Aucune propriété supplémentaire acceptée

Nom Type Requis Description
objectId string Requis Unique container identifier.
crid string Requis Business reference of the container.
urid string Facultatif Short recording identifier.
state ContainerState Requis Valeurs recording_open recording_closed
shipped boolean Requis
createdAt string Requis Contraintes format date-time
message ContainerListMessageInfo Facultatif

ContainerListMessageInfo Aucune propriété supplémentaire acceptée

Nom Type Requis Description
state MessageState Requis Valeurs pending_release released delivery_triggered unknown
videoUrl string Facultatif Contraintes format uri

ContainerListResponse Aucune propriété supplémentaire acceptée

Nom Type Requis Description
items array of ContainerListItem Requis
total integer Requis
limit integer Requis
skip integer Requis

ContainerMode

Type string

Valeurs single gallery

ContainerState

Type string

Valeurs recording_open recording_closed

CreateContainerInput Aucune propriété supplémentaire acceptée

Nom Type Requis Description
crid string Requis
emailObsolète string Facultatif Deprecated alias of sender.email. Contraintes format email
sender SenderInput Facultatif Optional sender identity and contact values.
recipient RecipientInput Facultatif Optional recipient identity and contact values. With no channel, email is selected when present. A phone-only recipient must set channel to sms.
language string Facultatif
codeGroup string Facultatif
mode ContainerMode Facultatif Container mode. single (default) holds one message; gallery accepts multiple messages. Ignored when the container already exists. Valeurs single gallery
additionalData object Facultatif Arbitrary metadata, preserved unchanged. Historical contact aliases remain recognized: email, senderEmail, sender first/last-name variants, receiverEmail, receiverPhone, and messageNotified.

CreateContainerOutput Aucune propriété supplémentaire acceptée

Nom Type Requis Description
crid string Requis
urid string Requis
state ContainerState Requis Valeurs recording_open recording_closed
mode ContainerMode Requis Valeurs single gallery
editKey string Facultatif Edit key returned only on container creation.
links ContainerLinks Requis

HealthStatus

Nom Type Requis Description
status string Requis Contraintes always ok
service string Requis Contraintes always client-api-v3

MessageDetailResponse

Nom Type Requis Description
objectId string Requis
state MessageState Requis Valeurs pending_release released delivery_triggered unknown
type integer Requis
createdAt string Requis Contraintes format date-time
updatedAt string Facultatif Contraintes format date-time
crid string Facultatif
urid string Facultatif
codeGroupId string Facultatif
videoUrl string Facultatif Contraintes format uri
thumbUrl string Facultatif Contraintes format uri
redeemCode string Facultatif Canonical redeem code normalized from message private data.
data object Facultatif
privateData object Facultatif
analysisData object Facultatif
language string Facultatif
scheduledAt string Facultatif Contraintes format date-time
activatedAt string Facultatif Contraintes format date-time
viewedAt string Facultatif Contraintes format date-time

MessageInfo Aucune propriété supplémentaire acceptée

Nom Type Requis Description
state MessageState Requis Valeurs pending_release released delivery_triggered unknown
videoUrl string Facultatif Contraintes format uri
data object Facultatif

MessageListItem

Nom Type Requis Description
objectId string Requis Unique message identifier (use for GET/PATCH /messages/{messageId}).
state MessageState Requis Valeurs pending_release released delivery_triggered unknown
type integer Requis
createdAt string Requis Contraintes format date-time
crid string Facultatif Business reference of the parent container.
urid string Facultatif Short recording identifier.
codeGroupId string Facultatif ObjectId of the code group (if assigned).
videoUrl string Facultatif Contraintes format uri
thumbUrl string Facultatif Contraintes format uri
redeemCode string Facultatif Canonical redeem code normalized from message private data.
data object Facultatif
privateData object Facultatif Private data (not visible to end users).
analysisData object Facultatif Analysis results (read-only).
language string Facultatif Language UID (e.g. fr, en_us).

MessageListResponse

Nom Type Requis Description
items array of MessageListItem Requis
total integer Requis
limit integer Requis
skip integer Requis

MessageState

Type string

Valeurs pending_release released delivery_triggered unknown

NotifyContainerInput Aucune propriété supplémentaire acceptée

Optional contact overrides applied immediately before delivery.

Nom Type Requis Description
sender SenderInput Facultatif Optional sender identity and contact values.
recipient RecipientInput Facultatif Optional recipient identity and contact values. With no channel, email is selected when present. A phone-only recipient must set channel to sms.

OperationResult Aucune propriété supplémentaire acceptée

Nom Type Requis Description
result string Requis Contraintes always ok

RecipientInput Aucune propriété supplémentaire acceptée

Optional recipient identity and contact values. With no channel, email is selected when present. A phone-only recipient must set channel to sms.

Nom Type Requis Description
firstName string Facultatif
lastName string Facultatif
email string Facultatif Contraintes format email
phone string Facultatif International E.164 phone number. Contraintes pattern ^\+[1-9][0-9]{7,14}$
channel string Facultatif Valeurs email sms

SenderInput Aucune propriété supplémentaire acceptée

Optional sender identity and contact values.

Nom Type Requis Description
firstName string Facultatif
lastName string Facultatif
email string Facultatif Contraintes format email

UpdateContainerInput Aucune propriété supplémentaire acceptée

Nom Type Requis Description
shipmentCarrier string Facultatif Valeurs chronopost ups coursier dhl other
shipmentCode string Facultatif
newcrid string Facultatif
language string Facultatif
emailObsolète string Facultatif Deprecated alias of sender.email. Contraintes format email
sender SenderInput Facultatif Optional sender identity and contact values.
recipient RecipientInput Facultatif Optional recipient identity and contact values. With no channel, email is selected when present. A phone-only recipient must set channel to sms.

UpdateMessageDataInput

Nom Type Requis Description
data object Facultatif Merge into message.data (keys overwrite, others preserved).
privateData object Facultatif Merge into message.privateData (validated against schema if defined).