Flujos

Recuperar todo

GET https://notifycame.com/api/flows/
curl --request GET \
--url 'https://notifycame.com/api/flows/' \
--header 'Authorization: Bearer {api_key}' \
Parámetros Detalles Descripción
page Opcional Entero El número de página del que desea resultados. Predeterminado a 1.
results_per_page Opcional Entero Cuántos resultados deseas por página. Los valores permitidos son: 10, 25, 50, 100, 250, 500, 1000. El valor predeterminado es 25.
search Opcional Cadena La cadena de búsqueda.
search_by Opcional Cadena ¿Qué campo está buscando? Los valores permitidos son: content.
segment Opcional Cadena Filter results by segment.
user_id Opcional Entero Filter results by user ID.
datetime_field Opcional Cadena Valores permitidos: last_sent_datetime, datetime, last_datetime
datetime_start Opcional Cadena Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end Opcional Cadena Filter results up to this datetime. Y-m-d H:i:s format.
order_by Opcional Cadena Por qué campo ordenar los resultados. Los valores permitidos son: flow_id, name, title, last_sent_datetime, datetime, last_datetime, total_sent_sms, total_pending_sms, total_failed_sms.
order_type Opcional Cadena El orden de los resultados. Los valores permitidos son: ASC para orden ascendente, y DESC para orden descendente. 
{
    "data": [
        {
            "id": 1,
            "device_id": 1,
            "sim_subscription_id": 1,
            "user_id": 1,
            "name": "Example",
            "content": "Sample message",
            "settings": {},
            "wait_time": 3,
            "wait_time_type": "days",
            "is_enabled": true,
            "total_sent_sms": 0,
            "total_pending_sms": 0,
            "total_failed_sms": 0,
            "last_sent_datetime": null,
            "last_datetime": null,
            "datetime": "2026-04-20 10:32:09",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://notifycame.com/api/flows?page=1",
        "last": "https://notifycame.com/api/flows?page=1",
        "next": null,
        "prev": null,
        "self": "https://notifycame.com/api/flows?page=1"
    }
}

Recuperar uno

GET https://notifycame.com/api/flows/{flow_id}
curl --request GET \
--url 'https://notifycame.com/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "device_id": 1,
        "sim_subscription_id": 1,
        "user_id": 1,
        "name": "Example",
        "content": "Sample message",
        "settings": {},
        "wait_time": 3,
        "wait_time_type": "days",
        "is_enabled": true,
        "total_sent_sms": 0,
        "total_pending_sms": 0,
        "total_failed_sms": 0,
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2026-04-20 10:32:09",
    }
}

Crear

POST https://notifycame.com/api/flows
Parámetros Detalles Descripción
name Requerido Cadena -
content Requerido Cadena -
device_id Requerido Entero -
sim_subscription_id Requerido Entero -
wait_time Requerido Entero -
wait_time_type Requerido Cadena Valores permitidos: minutes, hours, days
segment Opcional Cadena Valores permitidos: all, INT segment_id
is_enabled Opcional Boolean -
auto_apply_to_matching Opcional Boolean -
curl --request POST \
--url 'https://notifycame.com/api/flows' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'content=Hello world' \
--form 'device_id=1' \
--form 'sim_subscription_id=1' \
--form 'segment=all' \
{
    "data": {
        "id": 1
    }
}

Actualizar

POST https://notifycame.com/api/flows/{flow_id}
Parámetros Detalles Descripción
name Opcional Cadena -
content Opcional Cadena -
device_id Opcional Entero -
sim_subscription_id Opcional Entero -
wait_time Opcional Entero -
wait_time_type Opcional Cadena Valores permitidos: minutes, hours, days
segment Opcional Cadena Valores permitidos: all, INT segment_id
is_enabled Opcional Boolean -
curl --request POST \
--url 'https://notifycame.com/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'content=Hello world' \
--form 'device_id=1' \
--form 'sim_subscription_id=1' \
--form 'segment=all' \
{
    "data": {
        "id": 1
    }
}

Eliminar

DELETE https://notifycame.com/api/flows/{flow_id}
curl --request DELETE \
--url 'https://notifycame.com/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \