Plantillas

Recuperar Plantillas

get

Obtiene una lista de plantillas disponibles para el usuario.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

channel_idstringOptional

El ID único del canal para filtrar plantillas.

Example: 6744c294f11a1c5a4578fb80

Responses

200

Una lista de plantillas recuperada exitosamente.

application/json

idstringOptional

El ID único de la plantilla.

Example: 6722ca8d97447c11e31b1864

textstringOptional

El contenido de texto de la plantilla, incluyendo marcadores de posición.

Example: Estimado {{1}}, Te presentamos nuestra nueva web {{2}}

statusstring · enumOptional

El estado actual de la plantilla.

Example: activePossible values:

namespacestringOptional

El espacio de nombres de la plantilla.

Example: 2d36b9a9_dea7_40cd_93ba_ab9e49ff2e94

element_namestringOptional

El nombre único del elemento de la plantilla.

Example: notificacion_cambio

categorystringOptional

La categoría de la plantilla.

Example: UTILITY

buttonsstring[]Optional

Botones asociados con la plantilla.

remoteIdstringOptional

El ID remoto de la plantilla.

Example: 459936149920296

createdAtstring · date-timeOptional

La fecha de creación de la plantilla.

Example: 2024-10-31T00:08:45.823Z

updatedAtstring · date-timeOptional

La fecha de última actualización de la plantilla.

Example: 2024-12-13T19:15:34.911Z

footerstring · nullableOptional

Pie de página opcional para la plantilla.

reasonstring · nullableOptional

Razón del rechazo si el estado es 'rejected'.

401

No autorizado. El token proporcionado es inválido o falta.

500

Error interno del servidor.

get

/templates

HTTPcURLJavaScriptPython

GET /api/v1/templates HTTP/1.1
Host: core.sellia.com.mx
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "6722ca8d97447c11e31b1864",
    "campaign": {
      "id": "66183482e2ea04e264f6f8cb",
      "name": "My new campaign"
    },
    "channel": {
      "_id": "66a29ea50dcfe6af05793a15",
      "name": "Test"
    },
    "text": "Estimado {{1}},\n\nTe presentamos nuestra nueva web {{2}}",
    "status": "active",
    "namespace": "2d36b9a9_dea7_40cd_93ba_ab9e49ff2e94",
    "element_name": "notificacion_cambio",
    "category": "UTILITY",
    "settings": {
      "num_params": 2,
      "message_type": "text",
      "language_code": "es_MX"
    },
    "buttons": [],
    "remoteId": "459936149920296",
    "createdAt": "2024-10-31T00:08:45.823Z",
    "updatedAt": "2024-12-13T19:15:34.911Z",
    "footer": null,
    "reason": null
  }
]

Crear una Plantilla

post

Crea una nueva plantilla con la información proporcionada.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

channel_idstringRequired

El ID único del canal donde se usará la plantilla.

Example: 66a29ea50dcfe6af05793b15

typestring · enumRequired

El tipo de la plantilla.

Example: textPossible values:

textstringRequired

El contenido principal de la plantilla, incluyendo marcadores de posición.

Example: Estimado {{1}}, Te presentamos nuestra nueva web {{2}}

element_namestringRequired

El nombre único del elemento de la plantilla.

Example: notificacion_cambio

categorystringRequired

La categoría de la plantilla.

Example: UTILITY

buttonsstring[]Optional

Un array de botones asociados con la plantilla.

langstringRequired

El código de idioma de la plantilla.

Example: es_MX

bodyParamsstring[]Required

Los parámetros para reemplazar los marcadores de posición en la plantilla.

Example: ["Diego Olivera","https://develop.sellia.ai"]

multimediastring · nullableOptional

Contenido multimedia opcional para la plantilla.

previewstringOptional

Una vista previa de la plantilla.

Example: Estimado {{1}}, Te presentamos nuestra nueva web {{2}}

Responses

201

Plantilla creada exitosamente.

application/json

400

Solicitud incorrecta. Datos de entrada inválidos.

401

No autorizado. El token proporcionado es inválido o falta.

500

Error interno del servidor.

post

/templates

HTTPcURLJavaScriptPython

POST /api/v1/templates HTTP/1.1
Host: core.sellia.com.mx
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 388

{
  "channel_id": "66a29ea50dcfe6af05793b15",
  "type": "text",
  "text": "Estimado {{1}},\n\nTe presentamos nuestra nueva web {{2}}",
  "element_name": "notificacion_cambio",
  "category": "UTILITY",
  "buttons": [],
  "lang": "es_MX",
  "settings": {
    "message_type": "text"
  },
  "bodyParams": [
    "Diego Olivera",
    "https://develop.sellia.ai"
  ],
  "multimedia": "",
  "preview": "Estimado {{1}},\n\nTe presentamos nuestra nueva web {{2}}"
}

{
  "id": "6722ca8d97447c11e31b1864",
  "campaign": {
    "id": "66183482e2ea04e264f6f8cb",
    "name": "My new campaign"
  },
  "channel": {
    "_id": "66a29ea50dcfe6af05793a15",
    "name": "Test"
  },
  "text": "Estimado {{1}},\n\nTe presentamos nuestra nueva web {{2}}",
  "status": "active",
  "namespace": "2d36b9a9_dea7_40cd_93ba_ab9e49ff2e94",
  "element_name": "notificacion_cambio",
  "category": "UTILITY",
  "settings": {
    "num_params": 2,
    "message_type": "text",
    "language_code": "es_MX"
  },
  "buttons": [],
  "remoteId": "459936149920296",
  "createdAt": "2024-10-31T00:08:45.823Z",
  "updatedAt": "2024-12-13T19:15:34.911Z",
  "footer": null,
  "reason": null
}

Enviar una Plantilla

post

Envía una plantilla a los clientes especificados con los parámetros proporcionados.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

channelstringRequired

El ID único del canal donde se enviará la plantilla.

Example: 66a29ea50dcfe6af05793b15

templatestringRequired

El ID único de la plantilla que se enviará.

Example: 67211a8c0fa726afd801c862

Responses

200

Plantilla enviada exitosamente.

application/json

statusbooleanRequired

Indica si el envío fue iniciado exitosamente.

Example: true

sendIdstringRequired

ID único del envío. Usar este valor como parámetro en GET /templates/{sendId}/contacts para consultar el estado de entrega por contacto.

Example: 6993a66d80c63d3921247db3

messagestringRequired

Mensaje de estado de la operación.

Example: Sending templates

400

Solicitud incorrecta. Datos de entrada inválidos.

401

No autorizado. El token proporcionado es inválido o falta.

500

Error interno del servidor.

post

/templates/send

HTTPcURLJavaScriptPython

POST /api/v1/templates/send HTTP/1.1
Host: core.sellia.com.mx
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "channel": "66a29ea50dcfe6af05793b15",
  "template": "67211a8c0fa726afd801c862",
  "clients": [
    {
      "username": "5213323322722",
      "params": [
        "Diego",
        "https://sellia.com.mx",
        "1"
      ]
    }
  ]
}

{
  "status": true,
  "sendId": "6993a66d80c63d3921247db3",
  "message": "Sending templates"
}

Verificar Estado de Envío de Plantilla

get

Recupera el estado de entrega por contacto de un envío de plantilla. El parámetro sendId corresponde al campo sendId que devuelve POST /templates/send en su respuesta — NO es el ID de la plantilla. Usar este endpoint después de enviar una plantilla para conocer si cada mensaje fue entregado, leído o falló.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

sendIdstringRequired

El ID del envío obtenido del campo sendId en la respuesta de POST /templates/send.

Example: 6993a66d80c63d3921247db3

Responses

200

Lista de contactos recuperada exitosamente

application/json

totalintegerRequired

Número total de contactos

Example: 1

401

No autorizado - Token inválido o faltante

404

Plantilla no encontrada

get

/templates/{sendId}/contacts

HTTPcURLJavaScriptPython

GET /api/v1/templates/{sendId}/contacts HTTP/1.1
Host: core.sellia.com.mx
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "69014d059736203b46885350",
      "phone": "5213411378279",
      "status": "read",
      "messageId": "69014d3ae801a1a1e70f7007",
      "errorCode": null,
      "errorReason": null
    }
  ],
  "total": 1
}