Update Notification
Este endpoint permite actualizar una notificacion usando el uuid del mensaje previamente creado, este endpoint permite una amplia configuracion de los mensajes de igual forma que en la creacion.
Endpoint
Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Authorization | Bearer LVwuk3_oug0D60ZTwm... | access_token obtained in Atenea |
Url
Method: POST
URL: https://api.trust.lat/message-persistance/api/v1/factory/:uuid
Recuerda que para utilizar este endpoint es necesario un access token obtenido en el servicio Atenea
Path Variables
Key | Value | Description |
---|---|---|
uuid | 67ded174-a9ea... | Identificador unico de notifiacion |
Body
{
"notification_version": "trust_notifications_v1",
"notification_type": "dialog",
"data": {
"title": "titulo prueba",
"message": "body prueba",
"media_url": "https://.google.cl/photo.svg",
"action_color": "#348dfc"
},
"config": {
"priority": "normal",
"persistent": true,
"cancelable": true,
"play_time": 1,
"portrait": true,
"auto_play": true,
"is_sound": true
},
"buttons": {
"button_1": {
"action": "https://www.google.cl",
"color": "#348dfc",
"text": "Ir al sitio",
"type": "url"
},
"button_2": {
"action": "https://www.google.cl",
"color": "#348dfc",
"text": "Ir al sitio",
"type": "url"
}
},
"values": [],
"metadata": {
"reactions": [
"smile", "blush", "joy"
]
}
}
El campo notification_type indica el tipo de notificación que se desea crear pudiendo ser de notification, dialog, video o banner.
Field | Type | Required | Values | Examples | Comments |
---|---|---|---|---|---|
notification_version | String | true | [trust_notifications_v1] | trust_notifications_v1 | |
notification_type | String | true | [notification, dialog, video, banner] | notification | |
values | Array | true | [] | Must be a empty array |
Data
Este campo configura el contenido principal del mensaje, tener cuidado con las imagenes/videos y los colores. Imagenes: Deben ser https y accesible desde cualquier red, formatos permitidos .png y .jpg. Videos: Deben ser https y accesible desde cualquier red, formatos permitidos .mp4 y deben tener un peso ligero para evitar problemas de lentitud al mostrar el video. Color: Precaución con el formato, enviar un color en formato incorrecto causa problemas al mostrar la notificacion, formatos soportado RGB hexadecimal sin transparencia.
Field | Type | Required | Default | Comments | Examples |
---|---|---|---|---|---|
title | String | true | Title of message | ||
message | String | true | Body of message | ||
media_url | String, Url | true | Must be video o image url with https | https://trust-assets.s3.amazonaws.com/enrollment/dialogo_covid.png | |
action_color | String, Color | true | Color of buttons | #9E2626 |
Buttons
Define los botones que se mostrarán en los mensajes, por ahora solo se utilizaran button_1 y button_2 siendo este último opcional
Field | Type | Required | Default | Values | Comments | Examples |
---|---|---|---|---|---|---|
action | String, Url | true | Only 'high' or 'normal' | https://google.cl | ||
color | String, Color | false | RGB Hex color | #9E2626 | ||
text | String | true | Presione Aquí | |||
type | type | true | [url, call, mail] | url |
Config
Field | Type | Required | Default | Comments | Examples |
---|---|---|---|---|---|
priority | String | false | high | Only 'high' or 'normal' | high |
persistent | Boolean | false | false | true | |
cancelable | Boolean | false | false | false | |
play_time | Int | false | 0 | 5 |
Metadata
Field | Type | Required | Default | Comments | Examples |
---|---|---|---|---|---|
reactions | Array of strings | false | None | Array of strings than contains the "reaction_name" of emojis. Max 5, min 1 | reactions: [ "smile", "blush", "joy" ] |
Revisar la lista de emojis permitidos para este endpoint
Code Examples
- Curl
- JavaScript
- Python
curl --location --request POST 'api.trust.lat/api/v1/factory/67ded174-a9ea...' \
--header 'Content-Type: application/json' \
--data-raw '{
"notification_version": "trust_notifications_v1",
"notification_type": "dialog",
"data": {
"title": "titulo prueba",
"message": "body prueba",
"media_url": "https://.google.cl/photo.svg",
"action_color": "#348dfc"
},
"config": {
"priority": "normal",
"persistent": true,
"cancelable": true,
"play_time": 1,
"portrait": true,
"auto_play": true,
"is_sound": true
},
"buttons": {
"button_1": {
"action": "https://www.google.cl",
"color": "#348dfc",
"text": "Ir al sitio",
"type": "url"
},
"button_2": {
"action": "https://www.google.cl",
"color": "#348dfc",
"text": "Ir al sitio",
"type": "url"
}
},
"values": [],
"metadata": {
"reactions": [
"smile", "heart_eyes", "heart_eyes", "heart_eyes", "heart_eyes"
]
},
}'
import requests
import json
url = "api.trust.lat/api/v1/factory/67ded174-a9ea..."
payload = json.dumps({
"notification_version": "trust_notifications_v1",
"notification_type": "dialog",
"data": {
"title": "titulo prueba",
"message": "body prueba",
"media_url": "https://.google.cl/photo.svg",
"action_color": "#348dfc"
},
"config": {
"priority": "normal",
"persistent": True,
"cancelable": True,
"play_time": 1,
"portrait": True,
"auto_play": True,
"is_sound": True
},
"buttons": {
"button_1": {
"action": "https://www.google.cl",
"color": "#348dfc",
"text": "Ir al sitio",
"type": "url"
},
"button_2": {
"action": "https://www.google.cl",
"color": "#348dfc",
"text": "Ir al sitio",
"type": "url"
}
},
"values": [],
"metadata": {
"reactions": [
"smile", "heart_eyes", "heart_eyes", "heart_eyes", "heart_eyes"
]
}
})
headers = {
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
var axios = require('axios');
var data = JSON.stringify({
"notification_version": "trust_notifications_v1",
"notification_type": "dialog",
"data": {
"title": "titulo prueba",
"message": "body prueba",
"media_url": "https://.google.cl/photo.svg",
"action_color": "#348dfc"
},
"config": {
"priority": "normal",
"persistent": true,
"cancelable": true,
"play_time": 1,
"portrait": true,
"auto_play": true,
"is_sound": true
},
"buttons": {
"button_1": {
"action": "https://www.google.cl",
"color": "#348dfc",
"text": "Ir al sitio",
"type": "url"
},
"button_2": {
"action": "https://www.google.cl",
"color": "#348dfc",
"text": "Ir al sitio",
"type": "url"
}
},
"values": [],
"metadata": {
"reactions": [
"smile", "heart_eyes", "heart_eyes", "heart_eyes", "heart_eyes"
]
}
});
var config = {
method: 'post',
url: 'api.trust.lat/api/v1/factory/67ded174-a9ea...',
headers: {
'Content-Type': 'application/json'
},
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
Responses
HTTP Code: 201 Created
{
"code": 201,
"resource": "message",
"data": {
"id": 1,
"uuid": "05500f30-91c6...",
"custom_notification": {
"priority": "normal",
"data": {
"type": "dialog",
"reactions": "[{\"reaction_name\":\"rage\",\"emoji_hex\":\"U+1F621\"},{\"reaction_name\":\"cry\",\"emoji_hex\":\"U+1F622\"}]",
"notificationDialog": "{\"text_title\":\"titulo prueba\",\"text_body\":\"body prueba\",\"image_url\":\"https://.google.cl/photo.svg\",\"isPersistent\":true,\"isCancelable\":true,\"min_play_time\":\"1\",\"portrait\":true,\"autoPlay\":true,\"isSound\":true,\"buttons\":[{\"action\":\"https://www.google.cl\",\"color\":\"#348dfc\",\"text\":\"Ir al sitio\",\"type\":\"url\"},{\"action\":\"https://www.google.cl\",\"color\":\"#348dfc\",\"text\":\"Ir al sitio\",\"type\":\"url\"}]}"
},
"apns": {
"payload": {
"aps": {
"sound": "default",
"category": "url-url",
"mutable-content": 1,
"alert": {
"title": "titulo prueba",
"body": "body prueba"
},
"badge": 0
},
"data": {
"type": "dialog",
"reactions": "[{\"reaction_name\":\"rage\",\"emoji_hex\":\"U+1F621\"},{\"reaction_name\":\"cry\",\"emoji_hex\":\"U+1F622\"}]",
"notificationDialog": "{\"text_title\":\"titulo prueba\",\"text_body\":\"body prueba\",\"image_url\":\"https://.google.cl/photo.svg\",\"isPersistent\":true,\"isCancelable\":true,\"min_play_time\":\"1\",\"portrait\":true,\"autoPlay\":true,\"isSound\":true,\"buttons\":[{\"action\":\"https://www.google.cl\",\"color\":\"#348dfc\",\"text\":\"Ir al sitio\",\"type\":\"url\"},{\"action\":\"https://www.google.cl\",\"color\":\"#348dfc\",\"text\":\"Ir al sitio\",\"type\":\"url\"}]}"
}
}
}
},
"values": [],
"created_at": "2021-07-13T03:02:27.597Z",
"updated_at": "2021-07-13T03:02:27.597Z",
"status": true,
"type_notification": "trust_notifications_v1",
"disposable": false,
"version": 1,
"factory_message": {
"type": "dialog",
"data": {
"title": "titulo prueba",
"message": "body prueba",
"media_url": "https://.google.cl/photo.svg",
"action_color": "#348dfc"
},
"config": {
"priority": "normal",
"persistent": true,
"cancelable": true,
"play_time": 1,
"portrait": true,
"auto_play": true,
"is_sound": true
},
"buttons": {
"button_1": {
"action": "https://www.google.cl",
"color": "#348dfc",
"text": "Ir al sitio",
"type": "url"
},
"button_2": {
"action": "https://www.google.cl",
"color": "#348dfc",
"text": "Ir al sitio",
"type": "url"
}
},
"metadata": {
"reactions": [
"rage",
"cry"
]
}
},
"company_uuid": null
},
"message": "Created"
}