Schémas
V31Container
| Nom | Type | Requis | Description |
|---|---|---|---|
crid |
string
|
Requis | |
urid |
string
|
Requis | |
mode |
V31ContainerMode
|
Requis |
single holds one message (gift message); gallery accepts several (savings pot).
Required at creation and immutable afterwards.
Valeurs
single
gallery
|
state |
V31ContainerState
|
Requis |
Valeurs
recording_open
recording_closed
|
shipped |
boolean
|
Requis | |
shippedAt |
string | null
|
Requis | Contraintes format date-time |
notifiedAt |
string | null
|
Requis | Contraintes format date-time |
notifications |
V31Notifications
|
Requis | |
gallery |
V31Gallery | null
|
Requis |
null for a single container.
|
links |
V31ContainerLinks
|
Facultatif | |
createdAt |
string
|
Requis | Contraintes format date-time |
updatedAt |
string
|
Requis | Contraintes format date-time |
V31ContainerLinks
| Nom | Type | Requis | Description |
|---|---|---|---|
recordingUrl |
string
|
Requis | Contraintes format uri |
previewUrl |
string
|
Requis | Contraintes format uri |
V31ContainerList
| Nom | Type | Requis | Description |
|---|---|---|---|
items |
array of V31Container
|
Requis | |
total |
integer
|
Requis | |
limit |
integer
|
Requis | |
skip |
integer
|
Requis |
V31ContainerMode
single holds one message (gift message); gallery accepts several (savings pot).
Required at creation and immutable afterwards.
single
gallery
V31ContainerState
Valeurs
recording_open
recording_closed
V31CreateContainerRequest
Aucune propriété supplémentaire acceptée
| Nom | Type | Requis | Description |
|---|---|---|---|
crid |
string
|
Requis | Contraintes pattern ^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$ |
mode |
V31ContainerMode
|
Requis |
single holds one message (gift message); gallery accepts several (savings pot).
Required at creation and immutable afterwards.
Valeurs
single
gallery
|
language |
string
|
Facultatif |
uid of a platform language.
|
codeGroup |
string
|
Facultatif |
publicId of a code group of the platform; ignored when unknown.
|
sender |
V31Sender
|
Facultatif | |
recipient |
V31Recipient
|
Facultatif | |
gallery |
V31GalleryInput
|
Facultatif | |
notifications |
V31Notifications
|
Facultatif | |
additionalData |
object
|
Facultatif |
At most 20 keys matching ^[A-Za-z0-9_]{1,40}$; values are strings (500
characters at most), numbers or booleans. Key names containing mail or
phone are refused.
|
V31CreateContainerResponse
| Nom | Type | Requis | Description |
|---|---|---|---|
crid |
string
|
Requis | |
urid |
string
|
Requis | |
mode |
V31ContainerMode
|
Requis |
single holds one message (gift message); gallery accepts several (savings pot).
Required at creation and immutable afterwards.
Valeurs
single
gallery
|
state |
V31ContainerState
|
Requis |
Valeurs
recording_open
recording_closed
|
editKey |
string
|
Requis | Key of the first message. Returned at creation and replay only, never by a read. |
notifications |
V31Notifications
|
Requis | |
links |
V31ContainerLinks
|
Requis | |
platformId |
string
|
Requis | |
createdAt |
string
|
Requis | Contraintes format date-time |
V31Error
Aucune propriété supplémentaire acceptée
| Nom | Type | Requis | Description |
|---|---|---|---|
code |
string
|
Requis | |
message |
string
|
Requis |
V31ErrorEnvelope
Aucune propriété supplémentaire acceptée
| Nom | Type | Requis | Description |
|---|---|---|---|
error |
V31Error
|
Requis |
V31Gallery
| Nom | Type | Requis | Description |
|---|---|---|---|
title |
string | null
|
Requis | |
messageCount |
integer
|
Requis | |
listedCount |
integer
|
Requis | Messages publicly listed. |
closed |
boolean
|
Requis |
V31GalleryInput
Aucune propriété supplémentaire acceptée
| Nom | Type | Requis | Description |
|---|---|---|---|
title |
string
|
Facultatif | Contraintes max length 80 |
V31Health
| Nom | Type | Requis | Description |
|---|---|---|---|
status |
string
|
Requis | Contraintes always ok |
service |
string
|
Requis | Contraintes always client-api-v3 |
level |
string
|
Requis | Contraintes always v3.1 |
V31Message
Message view. thumbnailUrl, videoUrl, data and content are present only when
the platform messageAccess is admin; videoUrl and thumbnailUrl only in state
published.
| Nom | Type | Requis | Description |
|---|---|---|---|
messageId |
string
|
Requis | |
mrid |
string | null
|
Requis | |
role |
V31MessageRole
|
Requis |
Valeurs
organizer
contributor
|
state |
V31MessageState
|
Requis |
Valeurs
rejected
held
failed
processing
hidden
pending_review
published
|
held |
boolean
|
Requis | |
durationMs |
integer | null
|
Requis | |
revision |
integer
|
Requis | |
createdAt |
string
|
Requis | Contraintes format date-time |
updatedAt |
string
|
Requis | Contraintes format date-time |
releasedAt |
string | null
|
Requis | Contraintes format date-time |
viewedAt |
string | null
|
Requis | Contraintes format date-time |
thumbnailUrl |
string
|
Facultatif | Contraintes format uri |
videoUrl |
string
|
Facultatif | Contraintes format uri |
data |
object
|
Facultatif | |
data.firstname |
string
|
Facultatif | |
data.lastname |
string
|
Facultatif | |
data.relation |
string
|
Facultatif | |
content |
string
|
Facultatif |
V31MessageList
| Nom | Type | Requis | Description |
|---|---|---|---|
items |
array of V31Message
|
Requis | |
total |
integer
|
Requis | |
limit |
integer
|
Requis | |
skip |
integer
|
Requis |
V31MessageRole
Valeurs
organizer
contributor
V31MessageState
Valeurs
rejected
held
failed
processing
hidden
pending_review
published
V31Notifications
Aucune propriété supplémentaire acceptée
| Nom | Type | Requis | Description |
|---|---|---|---|
organizer |
V31NotifyChoice
|
Facultatif |
Who sends the e-mails of an audience: livstick (default), client (your platform
sends its own) or none.
Valeurs
livstick
client
none
|
contributors |
V31NotifyChoice
|
Facultatif |
Who sends the e-mails of an audience: livstick (default), client (your platform
sends its own) or none.
Valeurs
livstick
client
none
|
recipient |
V31NotifyChoice
|
Facultatif |
Who sends the e-mails of an audience: livstick (default), client (your platform
sends its own) or none.
Valeurs
livstick
client
none
|
V31NotifyChoice
Who sends the e-mails of an audience: livstick (default), client (your platform
sends its own) or none.
livstick
client
none
V31NotifyRequest
Aucune propriété supplémentaire acceptée
| Nom | Type | Requis | Description |
|---|---|---|---|
recipient |
object
|
Facultatif | |
recipient.firstName |
string
|
Facultatif | Contraintes max length 50 |
recipient.email |
string
|
Facultatif | Contraintes max length 254, format email |
V31NotifyResponse
| Nom | Type | Requis | Description |
|---|---|---|---|
result |
string
|
Requis | Contraintes always ok |
notifiedAt |
string
|
Requis | Contraintes format date-time |
emailQueued |
boolean
|
Requis |
true when the recipient notification is livstick and an address is present.
|
V31Recipient
Aucune propriété supplémentaire acceptée
| Nom | Type | Requis | Description |
|---|---|---|---|
firstName |
string
|
Facultatif | Contraintes max length 50 |
lastName |
string
|
Facultatif | Contraintes max length 50 |
email |
string
|
Facultatif | Contraintes max length 254, format email |
phone |
string
|
Facultatif | E.164 phone number. Contraintes pattern ^\+[1-9][0-9]{7,14}$ |
V31RecordTokenRequest
Aucune propriété supplémentaire acceptée
| Nom | Type | Requis | Description |
|---|---|---|---|
mrid |
string
|
Requis | Contraintes pattern ^[A-Za-z0-9:_-]{1,64}$ |
role |
V31MessageRole
|
Facultatif |
Valeurs
organizer
contributor
|
hold |
boolean
|
Facultatif |
Encode the video but wait for release before publishing it.
Par défaut
false
|
sender |
object
|
Facultatif | |
sender.firstName |
string
|
Facultatif | Contraintes max length 50 |
sender.lastName |
string
|
Facultatif | Contraintes max length 50 |
expiresIn |
integer
|
Facultatif |
Lifetime in seconds.
Par défaut
3600
Contraintes
min 60, max 86400
|
V31RecordTokenResponse
| Nom | Type | Requis | Description |
|---|---|---|---|
recordToken |
string
|
Requis | |
urid |
string
|
Requis | |
mrid |
string
|
Requis | |
role |
V31MessageRole
|
Requis |
Valeurs
organizer
contributor
|
hold |
boolean
|
Requis | |
expiresAt |
string
|
Requis | Contraintes format date-time |
V31Sender
Aucune propriété supplémentaire acceptée
| Nom | Type | Requis | Description |
|---|---|---|---|
firstName |
string
|
Facultatif | Contraintes max length 50 |
lastName |
string
|
Facultatif | Contraintes max length 50 |
email |
string
|
Facultatif | Contraintes max length 254, format email |
V31UnlockResponse
| Nom | Type | Requis | Description |
|---|---|---|---|
result |
string
|
Requis | Contraintes always ok |
shipped |
boolean
|
Requis | |
shippedAt |
string
|
Requis | Contraintes format date-time |
V31UpdateContainerRequest
Aucune propriété supplémentaire acceptée
| Nom | Type | Requis | Description |
|---|---|---|---|
shipmentCarrier |
string
|
Facultatif | |
shipmentCode |
string
|
Facultatif | Contraintes max length 100 |
newcrid |
string
|
Facultatif | Contraintes pattern ^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$ |
language |
string
|
Facultatif | |
sender |
V31Sender
|
Facultatif | |
recipient |
V31Recipient
|
Facultatif | |
notifications |
V31Notifications
|
Facultatif | |
gallery |
V31GalleryInput
|
Facultatif |
V31ViewTokenRequest
Aucune propriété supplémentaire acceptée
| Nom | Type | Requis | Description |
|---|---|---|---|
scope |
string
|
Requis |
Valeurs
viewer
owner
|
mrid |
string
|
Facultatif | Optional; must exist. Contraintes pattern ^[A-Za-z0-9:_-]{1,64}$ |
expiresIn |
integer
|
Facultatif |
Lifetime in seconds.
Par défaut
900
Contraintes
min 60, max 3600
|
V31ViewTokenResponse
| Nom | Type | Requis | Description |
|---|---|---|---|
viewToken |
string
|
Requis | |
scope |
string
|
Requis |
Valeurs
viewer
owner
|
mrid |
string | null
|
Requis | |
expiresAt |
string
|
Requis | Contraintes format date-time |
V31WebhookDelivery
| Nom | Type | Requis | Description |
|---|---|---|---|
deliveryId |
string
|
Requis | |
eventId |
string
|
Requis | |
eventType |
string
|
Requis | |
endpointId |
string
|
Requis | |
crid |
string | null
|
Facultatif | |
mrid |
string | null
|
Facultatif | |
state |
string
|
Requis |
Valeurs
pending
done
failed
skipped
|
attempts |
integer
|
Requis | |
lastStatus |
integer | null
|
Facultatif | |
nextAttemptAt |
string | null
|
Facultatif | Contraintes format date-time |
createdAt |
string
|
Requis | Contraintes format date-time |
updatedAt |
string
|
Requis | Contraintes format date-time |
V31WebhookDeliveryList
| Nom | Type | Requis | Description |
|---|---|---|---|
items |
array of V31WebhookDelivery
|
Requis | |
total |
integer
|
Requis | |
limit |
integer
|
Requis | |
skip |
integer
|
Requis |