Schémas
DetailsResponse
| Nom | Type | Requis | Description |
|---|---|---|---|
status |
integer
|
Requis | Legacy numeric Message status. |
data |
object
|
Requis | |
data.videoUrl |
string
|
Facultatif | Contraintes format uri |
data.messageUrl |
string
|
Requis | Legacy read URL without scheme. |
data.urlRead |
string
|
Requis | Contraintes format uri |
data.urlWrite |
string
|
Requis | Contraintes format uri |
data.urlPreview |
string
|
Requis | Contraintes format uri |
data.shipped |
boolean
|
Requis |
HealthStatus
| Nom | Type | Requis | Description |
|---|---|---|---|
status |
string
|
Requis | |
service |
string
|
Requis |
LegacyError
| Nom | Type | Requis | Description |
|---|---|---|---|
status |
integer
|
Requis |
Legacy error marker.
Valeurs
1
|
error |
string
|
Requis |
Valeurs
key_invalid
forbidden
auth_unavailable
crid_unknown
data_invalid
no_message_for_this_crid
message_missing
no_language_found
no_pdf_template
card_renderer_unavailable
card_renderer_failed
webhook_not_found
internal_error
|
shipped |
boolean
|
Facultatif |
Present only for details when a shipped code has no message.
|
LegacyWebhookProcessed
| Nom | Type | Requis | Description |
|---|---|---|---|
status |
integer
|
Requis |
Valeurs
1
|
error |
string
|
Requis |
Valeurs
processed
|
ModifyRequest
| Nom | Type | Requis | Description |
|---|---|---|---|
shipmentCarrier |
string
|
Facultatif |
Valeurs
chronopost
ups
coursier
dhl
other
|
shipmentCode |
string
|
Facultatif | |
newcrid |
string
|
Facultatif | Replacement client reference ID. |
language |
string
|
Facultatif | |
email |
string
|
Facultatif | Contraintes format email |
OperationStatus
| Nom | Type | Requis | Description |
|---|---|---|---|
status |
integer
|
Requis |
Valeurs
0
|
QRCodeOptions
| Nom | Type | Requis | Description |
|---|---|---|---|
dark |
string
|
Facultatif | |
light |
string
|
Facultatif | |
extension |
string
|
Facultatif |
Filename extension hint only; image body remains PNG.
Par défaut
png
|
size |
integer
|
Facultatif |
Par défaut
256
Contraintes
min 64
|
RedirectURLResponse
| Nom | Type | Requis | Description |
|---|---|---|---|
url |
string
|
Requis | Contraintes format uri |
urlPreview |
string
|
Requis | Contraintes format uri |
RetargetRequest
| Nom | Type | Requis | Description |
|---|---|---|---|
email |
string
|
Facultatif | Sender or retargeting email stored in Code data. Contraintes format email |
language |
string
|
Facultatif | Language code stored in Code data. |
codeGroup |
string
|
Facultatif | Public CodeGroup identifier. |
additionalData |
object
|
Facultatif | Extra data merged into Code data. |
RetargetResponse
| Nom | Type | Requis | Description |
|---|---|---|---|
urlRead |
string
|
Requis | Recipient reading URL, never preview. Contraintes format uri |
urlWrite |
string
|
Requis | Sender overwrite URL. Contraintes format uri |
urlPreview |
string
|
Requis | Legacy preview URL. Contraintes format uri |
status |
integer
|
Requis |
Valeurs
0
|
url |
string
|
Requis |
Legacy default destination; urlWrite when default_message is enabled, otherwise urlRead.
Contraintes
format uri
|
urid |
string
|
Requis | |
messageUrl |
string
|
Requis |
Legacy alias for urlRead.
Contraintes
format uri
|
URLSet
| Nom | Type | Requis | Description |
|---|---|---|---|
urlRead |
string
|
Requis | Recipient reading URL, never preview. Contraintes format uri |
urlWrite |
string
|
Requis | Sender overwrite URL. Contraintes format uri |
urlPreview |
string
|
Requis | Legacy preview URL. Contraintes format uri |