Campañas

Recuperar todo

GET https://notifycame.com/api/campaigns/
curl --request GET \
--url 'https://notifycame.com/api/campaigns/' \
--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: name, content.
status Opcional Cadena Valores permitidos: draft, scheduled, processing, sent
segment Opcional Cadena Filter results by segment.
rss_automation_id Opcional Entero Filter results by RSS automation ID.
user_id Opcional Entero Filter results by user ID.
datetime_field Opcional Cadena Valores permitidos: datetime, scheduled_datetime, last_sent_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: campaign_id, name, content, datetime, scheduled_datetime, last_sent_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,
            "rss_automation_id": 0,
            "recurring_campaign_id": 1,
            "device_id": 1,
            "sim_subscription_id": 1,
            "user_id": 1,
            "name": "Example",
            "content": "Sample message",
            "segment": "all",
            "settings": {
                "is_scheduled": 0,
            },
            "contacts_ids": [
                1,2,3,4,5
            ],
            "sent_contacts_ids": [],
            "total_sent_sms": 0,
            "total_pending_sms": 1,
            "total_failed_sms": 0,
            "status": "draft",
            "scheduled_datetime": "2026-04-22 08:58:01",
            "last_sent_datetime": null,
            "last_datetime": null,
            "datetime": "2026-04-22 08:58:01",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://notifycame.com/api/campaigns?page=1",
        "last": "https://notifycame.com/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://notifycame.com/api/campaigns?page=1"
    }
}

Recuperar uno

GET https://notifycame.com/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://notifycame.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "rss_automation_id": 0,
        "recurring_campaign_id": 1,
        "device_id": 1,
        "sim_subscription_id": 1,
        "user_id": 1,
        "name": "Example",
        "content": "Sample message",
        "segment": "all",
        "settings": {
            "is_scheduled": 0,
        },
        "contacts_ids": [
            1,2,3,4,5
        ],
        "sent_contacts_ids": [],
        "total_sent_sms": 0,
        "total_pending_sms": 1,
        "total_failed_sms": 0,
        "status": "draft",
        "scheduled_datetime": "2026-04-22 08:58:01",
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2026-04-22 08:58:01",
    }
}

Crear

POST https://notifycame.com/api/campaigns
Parámetros Detalles Descripción
name Requerido Cadena -
content Requerido Cadena -
device_id Requerido Entero -
sim_subscription_id Requerido Entero -
is_scheduled Opcional Boolean -
scheduled_datetime Opcional Cadena -
segment Opcional Cadena Valores permitidos: all, bulk, custom, filter, INT segment_id
phone_numbers Opcional Cadena Disponible cuando: segment = bulk
contacts_ids Opcional Cadena Disponible cuando: segment = custom
filters_custom_parameter_key[index] Opcional Cadena Disponible cuando: segment = filter
filters_custom_parameter_condition[index] Opcional Cadena Valores permitidos: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than Disponible cuando: segment = filter
filters_custom_parameter_value[index] Opcional Cadena Disponible cuando: segment = filter
filters_countries[] Opcional Cadena Disponible cuando: segment = filter
filters_continents[] Opcional Cadena Disponible cuando: segment = filter
save Opcional Boolean Guardar borrador
send Opcional Boolean Enviar campaña
curl --request POST \
--url 'https://notifycame.com/api/campaigns' \
--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/campaigns/{campaign_id}
Parámetros Detalles Descripción
name Opcional Cadena -
content Opcional Cadena -
device_id Opcional Entero -
sim_subscription_id Opcional Entero -
is_scheduled Opcional Boolean -
scheduled_datetime Opcional Cadena -
segment Opcional Cadena Valores permitidos: all, bulk, custom, filter, INT segment_id
phone_numbers Opcional Cadena Disponible cuando: segment = bulk
contacts_ids Opcional Cadena Disponible cuando: segment = custom
filters_custom_parameter_key[index] Opcional Cadena Disponible cuando: segment = filter
filters_custom_parameter_condition[index] Opcional Cadena Valores permitidos: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than Disponible cuando: segment = filter
filters_custom_parameter_value[index] Opcional Cadena Disponible cuando: segment = filter
filters_custom_parameter_value[index] Opcional Cadena Disponible cuando: segment = filter
filters_countries[] Opcional Cadena Disponible cuando: segment = filter
filters_continents[] Opcional Cadena Disponible cuando: segment = filter
save Opcional Boolean Guardar borrador
send Opcional Boolean Enviar campaña
curl --request POST \
--url 'https://notifycame.com/api/campaigns/{campaign_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/campaigns/{campaign_id}
curl --request DELETE \
--url 'https://notifycame.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \