image


indigitall API


Contents

  1. List of API endpoints
  2. Messages
  3. Sending messages
  4. Statistics
  5. Areas
  6. Devices
  7. Remote configuration of the SDK
  8. Appush multiple creation and send

List of API endpoints

All end-points are in the same URL and you should always associate the app_token (identifies application and environment) and access_token (for security) as parameters.

For request GET:
url:
api/external/{action}?app_token={id}&access_token={token}

For request POST:
url: api/external/{action}
content-type: application/json
body:

{
    app_token: {id},
    access_token: {token}
}

All calls will be made under HTTPS.

The "action" parameter can be:

{action} Description
api_push_message_create​ create a message
api_push_message_list​ returns a list of messages created between the indicated dates
api_push_message_remove​ delete a message that has not yet been sent
api_push_send_device​ send a message to a device
api_push_send​ send a message to multiple devices
api_push_get_status​ returns a summary of shipping statistics
api_tag_tree​ returns the list of device groups
api_temporal_tag_create creates a group of devices with a fixed duration
api_temporal_tag_update associates devices with a group
api_temporal_tag_commit prepare a group to be able to make a segmented shipment
api_update_application_conf sets the update time of the device location

Messages

Endpoint to manage notifications.

List message

Method:: GET Endpoint: api/external/api_push_message_list

Parameters:

Name type description optional
date_from string yyyy-mm-dd no
date_to string yyyy-mm-dd no

Request example: api/external/api_push_message_list?date_from=2016-12-01&date_to=2017-02-01

Response example:

{
  "status_code": 200,
  "status_txt": "Lista de mensajes",
  "data": [{
    "id": 8565,
    "title": "title",
    "description": "body",
    "titleIos": "title & body for iOS9-",
    "type": 9,
    "createdAt": {
      "date": "2017-01-09 22:46:47",
      "timezone_type": 3,
      "timezone": "Europe/Berlin"
    }
  }]
}

Create message

Method: POST
Endpoint: api/external/api_push_message_create

Parameters:

WebPush

Name type description optional
type = 8 number Only allows “with image” type for webPush no
buttonIcon = 4 number Only allows “open page” action for webPush no
os = 9 number Send only to browsers no
titleSafari string Title for Safari no
descriptionSafari string Body for Safari no
titleChrome string Title for Chrome and Firefox no
descriptionChrome string Body for Chrome and Firefox no
descCampaign string Description of the campaign to associate with the message yes
uri url Page that opens by clicking on the notification no
wallpaper_thumb url URL of the image no
scheduled_at date Programming sending date in format YYYY-MM-DD HH:mm:ss yes
postal_code_from string Start of the postal codes range yes
postal_code_to string End of the postal codes range yes
postal_code string List of postal codes separated by commas yes
country string List of countries separated by commas yes
areas string List of areas separated by commas yes
tags string custom_id of the interest groups by which you want to filter separated by commas yes
no_tags string custom_id of the interest groups to exclude by which you want to filter separated by commas yes
ttl number Number of hours after which it will retry to send a notification to a user without connection yes
ctid string custom_id of the message category yes
requireInteraction number If it is 1, notification will not dissapear until the user interact with it (only WebPush) yes

Example:

{
  "type": 8,
  "buttonIcon": 4,
  "os": 9,
  "titleSafari": "Test",
  "descriptionSafari": "This is a test",
  "titleChrome": "Test",
  "descriptionChrome": "This is a test",
  "descCampaign": "description campaign",
  "uri": "https://indigitall.net",
  "wallpaper_thumb": "https://pruebas.indigitall.net/bundles/smart2mebackend/images/logo/azul_l.png"
}

AppPush with photo, action “open app”

Name type description optional
type = 8 number Type “with image” for appPush no
buttonIcon = 6 number Action “open app” for appPush no
os = 10 number Send only to mobile application no
title string Title of the message for iOS10+ and Android no
description string Body of the message for iOS10+ and Android no
titleIos string Body of the message for iOS9 and previous no
uri string Custom parameters that the application receives yes
wallpaper_thumb url URL of the image no
gifAnimated url Url of animated gif yes
button string Text of the button in the bottom toolbar (for SDK Indigitall lower than v2.2.0 Android and v2.0.0 iOS) no
text string Text of the bottom toolbar (for SDK Indigitall lower than v2.2.0 Android and v2.0.0 iOS) no
scheduled_at date Programming sending date in format YYYY-MM-DD HH:mm:ss yes
postal_code_from string Start of the postal codes range yes
postal_code_to string End of the postal codes range yes
postal_code string List of postal codes separated by commas yes
country string List of countries separated by commas yes
areas string List of areas separated by commas yes
tags string custom_id of the interest groups by which you want to filter separated by commas yes
no_tags string custom_id of the interest groups to exclude by which you want to filter separated by commas yes
ttl number Number of hours after which it will retry to send a notification to a user without connection yes
ctid string custom_id of the message category yes

Example:

{
  "type": 8,
  "buttonIcon": 6,
  "os": 10,
  "title": "Test",
  "description": "This is a test",
  "titleIos": "Test",
  "button": "This is a test",
  "text": "Indigitall",
  "wallpaper_thumb": "https://pruebas.indigitall.net/bundles/smart2mebackend/images/logo/azul_l.png"
}

Parameters (appPush with photo, action “open page”):

Name type description optional
type = 8 number Type “with image” for appPush no
buttonIcon = 4 number Action “open app” for appPush no
os = 10 number Send only to mobile application no
title string Title of the message for iOS10+ and Android no
description string Body of the message for iOS10+ and Android no
titleIos string Body of the message for iOS9 and previous no
uri string Page that opens by clicking on the notification no
wallpaper_thumb url URL of the image no
gifAnimated url Url of animated gif yes
button string Text of the button in the bottom toolbar (for SDK Indigitall lower than v2.2.0 Android and v2.0.0 iOS) no
text string Text of the bottom toolbar (for SDK Indigitall lower than v2.2.0 Android and v2.0.0 iOS) no
scheduled_at date Programming sending date in format YYYY-MM-DD HH:mm:ss yes
postal_code_from string Start of the postal codes range yes
postal_code_to string End of the postal codes range yes
postal_code string List of postal codes separated by commas yes
country string List of countries separated by commas yes
areas string List of areas separated by commas yes
tags string custom_id of the interest groups by which you want to filter separated by commas yes
no_tags string custom_id of the interest groups to exclude by which you want to filter separated by commas yes
ttl number Number of hours after which it will retry to send a notification to a user without connection yes
ctid string custom_id of the message category yes

Example:

{
  "type": 8,
  "buttonIcon": 4,
  "os": 10,
  "title": "Test",
  "description": "This is a test",
  "titleIos": "Test",
  "uri": "https://indigitall.net",
  "button": "This is a test",
  "text": "Indigitall",
  "wallpaper_thumb": "https://pruebas.indigitall.net/bundles/smart2mebackend/images/logo/azul_l.png"
}

Parameters (appPush with photo, action “call”):

Name type description optional
type = 8 number Type “with image” for appPush no
buttonIcon = 1 number Action “call” for appPush no
os = 10 number Send only to mobile application no
title string Title of the message for iOS10+ and Android no
description string Body of the message for iOS10+ and Android no
titleIos string Body of the message for iOS9 and previous no
uri string Telephone number for the call no
wallpaper_thumb url URL of the image no
gifAnimated url Url of animated gif yes
button string Text of the button in the bottom toolbar (for SDK Indigitall lower than v2.2.0 Android and v2.0.0 iOS) no
text string Text of the bottom toolbar (for SDK Indigitall lower than v2.2.0 Android and v2.0.0 iOS) no
scheduled_at date Programming sending date in format YYYY-MM-DD HH:mm:ss si
postal_code_from string Start of the postal codes range si
postal_code_to string End of the postal codes range si
postal_code string List of postal codes separated by commas si
country string List of countries separated by commas si
areas string List of areas separated by commas si
tags string custom_id of the interest groups by which you want to filter separated by commas si
no_tags string custom_id of the interest groups to exclude by which you want to filter separated by commas yes
ttl number Number of hours after which it will retry to send a notification to a user without connection si
ctid string custom_id of the message category yes

Example:

{
  "type": 8,
  "buttonIcon": 1,
  "os": 10,
  "title": "Test",
  "description": "This is a test",
  "titleIos": "Test",
  "uri": "666 666 666",
  "button": "This is a test",
  "text": "Indigitall",
  "wallpaper_thumb": "https://pruebas.indigitall.net/bundles/smart2mebackend/images/logo/azul_l.png"
}

Parameters (appPush with photo, action “share social network”):

Name type description optional
type = 8 number Type “with image” for appPush no
buttonIcon = 7 number Action “share social network” for appPush no
os = 10 number Send only to mobile application no
title string Title of the message for iOS10+ and Android no
description string Body of the message for iOS10+ and Android no
titleIos string Body of the message for iOS9 and previous no
uri string URL that is going to be shared no
wallpaper_thumb url URL of the image no
gifAnimated url Url of animated gif yes
button string Text of the button in the bottom toolbar (for SDK Indigitall lower than v2.2.0 Android and v2.0.0 iOS) no
text string Text of the bottom toolbar (for SDK Indigitall lower than v2.2.0 Android and v2.0.0 iOS) no
scheduled_at date Programming sending date in format YYYY-MM-DD HH:mm:ss si
postal_code_from string Start of the postal codes range si
postal_code_to string End of the postal codes range si
postal_code string List of postal codes separated by commas si
country string List of countries separated by commas si
areas string List of areas separated by commas si
tags string custom_id of the interest groups by which you want to filter separated by commas si
no_tags string custom_id of the interest groups to exclude by which you want to filter separated by commas yes
ttl number Number of hours after which it will retry to send a notification to a user without connection si
ctid string custom_id of the message category yes

Example:

{
  "type": 8,
  "buttonIcon": 7,
  "os": 10,
  "title": "Test",
  "description": "This is a test",
  "titleIos": "Test",
  "uri": "https://indigitall.net",
  "button": "This is a test",
  "text": "Indigitall",
  "wallpaper_thumb": "https://pruebas.indigitall.net/bundles/smart2mebackend/images/logo/azul_l.png"
}

Parameters (appPush without photo, action “open app”):

Name type description optional
type = 9 number Action “open app” for appPush no
os = 10 number Send only to mobile application no
title string Title of the message for iOS10+ and Android no
description string Body of the message for iOS10+ and Android no
titleIos string Body of the message for iOS9 and previous no
uri string Custom parameters that the application receives si
scheduled_at date Programming sending date in format YYYY-MM-DD HH:mm:ss si
postal_code_from string Start of the postal codes range si
postal_code_to string End of the postal codes range si
postal_code string List of postal codes separated by commas si
country string List of countries separated by commas si
areas string List of areas separated by commas si
tags string custom_id of the interest groups by which you want to filter separated by commas si
no_tags string custom_id of the interest groups to exclude by which you want to filter separated by commas yes
ttl number Number of hours after which it will retry to send a notification to a user without connection si
ctid string custom_id of the message category yes

Example:

{
  "type": 9,
  "os": 10,
  "title": "Test",
  "description": "This is a test",
  "titleIos": "Test"
}

Parameters (appPush without photo, action “open page”):

Name type description optional
type = 4 number Action “open page” for appPush no
os = 10 number Send only to mobile application no
title string Title of the message for iOS10+ and Android no
description string Body of the message for iOS10+ and Android no
titleIos string Body of the message for iOS9 and previous no
uri string Page that opens by clicking on the notification no
scheduled_at date Programming sending date in format YYYY-MM-DD HH:mm:ss si
postal_code_from string Start of the postal codes range si
postal_code_to string End of the postal codes range si
postal_code string List of postal codes separated by commas si
country string List of countries separated by commas si
areas string List of areas separated by commas si
tags string custom_id of the interest groups by which you want to filter separated by commas si
no_tags string custom_id of the interest groups to exclude by which you want to filter separated by commas yes
ttl number Number of hours after which it will retry to send a notification to a user without connection si
ctid string custom_id of the message category yes

Example: api/external/api_push_message_create

{
  "type": 4,
  "os": 10,
  "title": "Test",
  "description": "This is a test",
  "titleIos": "Test",
  "uri": "https://indigitall.net"
}

Response example:

{
  "status_code": 200,
  "status_txt": "Entidad Message creada",
  "data": {
    "message_id": 8567
  }
}

Delete message

Only those messages that still have not been sent, including those with future sending programming can be deleted.

Endpoint: HTTP POST api/external/api_push_message_remove Content-type: application/json

Parameters:

Name type description optional
message_id number 1234 no

Example: api/external/api_push_message_remove

{
  "message_id": 2
}

Response example:

{
  "status_code": 200,
  "status_txt": "Mensaje eliminado correctamente"
}


Sending Messages

To a device

This method is recommended for send testing, because it reduces the risk of a message reaching all users if the developer makes some mistake (e.g. setting the app_token for development environment).

On the other hand, it should not be used for sending to groups of users, since it would have to make many calls to this endpoint (one for each user).

The message that is sent by this endpoint, can be forwarded multiple times with repeated calls. You don't have to create a new message whenever you want to send it.

Endpoint: HTTP POST api/external/api_push_send_device Content-type: application/json

Parameters:

Name type description optional
message_id number Message ID no
device_id string Device ID. The browsers and mobile devices SDK generates this ID when it is initialized for the first no time. Collecting these IDs and associate them to the user is the responsibility of the developer’s application. no

Example: api/external/api_push_send_device

{
  "message_id": 2,
  "device_id": "ANDROID-MOTOROLA-07A86B23-D310-4E16-A53D-133C145CD642"
}

Response example:

{
  "status_code": 200,
  "status_txt": "Push enviado"
}

To multiple devices


Send to all the devices

A message that is sent by the endpoint of this section, may not be forwarded multiple times with repeated calls. It is necessary to create a new message every time you want to send it. The message that is sent on a massive scale, is automatically blocked to reduce the risk of spam in the event the developer makes a mistake.

Endpoint: HTTP POST api/external/api_push_send Content-type: application/json

Parameters:

Name type description optional
message_id number Message ID no

Example: api/external/api_push_send

{
  "message_id": 2
}

Response example:

{
  "status_code": 200,
  "status_txt": "Push enviado"
}

Send to a group of devices

To perform a segmented sending by selecting a subset of devices, you must follow the steps below:

  • Create a group of devices
  • Add devices to the group
  • Create a message, setting as a filter the created group of devices
  • Send message

Create a group of devices

Endpoint: HTTP POST api/external/api_temporal_tag_create Content-type: application/json

Parameters:

Name type description optional
custom_id string Group ID no
name string Descriptive name for the group. By default, it will be the date of creation with format yyyymmdd si
expiration_date string Expiration date of the group. It must be later than the current format yyyymmdd. By default, 7 days after the date yes of creation si

Example: api/external/api_temporal_tag_create

{
  "custom_id": 1234
}

Response example:

{
  "status_code": 200,
  "status_txt": "Entidad Tag creada",
  "data": {
    "Id": 1082,
    "custom_id": "1234"
  }
}

Add devices to the group

This endpoint is designed to load large quantities of devices in a short period of time. To achieve greater speed, we recommend to make 20 calls in parallel with 1000 devices each.

Endpoint: HTTP POST api/external/api_temporal_tag_update Content-type: application/json

Parameters:

Name type description optional
custom_id string Group ID no
operation string “A” to add devices to the group and “R” to delete them. By default, “A” si
devices Array List of devices you want to add/delete. Maximum 1000, minimum 1 no

Example: api/external/api_temporal_tag_update

{
  "custom_id": 1234,
  "devices": [
    "deviceId1",
    "deviceId2",
    "deviceId3"
  ]
}

Response example:

{
  "status_code": 200,
  "status_txt": "Dispositivos agregados correctamente",
  "data": {
    "Id": 1082,
    "custom_id": "1234"
  }
}

Commit

When the device dump has been completed, it is necessary to commit before sending messages.

Endpoint: HTTP POST api/external/api_temporal_tag_commit Content-type: application/json

Parameters:

Name type description optional
custom_id string Group ID no

Example: api/external/api_temporal_tag_commit

Response example:

{
  "status_code": 200,
  "status_txt": "El grupo de dispositivos está preparado para el envío",
  "data": {
    "Id": 1082,
    "custom_id": "1234"
  }
}

Sending

To send to the device group you have just created simply create a message by adding the custom_id as parameter tags.

Statistics

Endpoint to get statistics

A Message

Once a message has been sent, this endpoint can be used to obtain information on the sending status.

Method: GET
Endpoint: api/external/api_push_get_status Content-type: application/json

Parameters:

Name type description optional
message_id number Message ID no

Example: api/external/api_push_get_status?message_id=1234

Response example:

{
  status_code: 200
  status_txt: "Estado del push"
  data: [
    { sent: "15" },
    { clicked: "3" }
  ]
}

Time period

Download information of the devices that have interacted with the different messages in a range of dates.

Method: GET
Endpoint: api/external/periodStatistics
Content-type: application/json

Parameters:

Name type description optional
from Date Pattern dd-mm-aaaa no
to Date Pattern dd-mm-aaaa no

Example: api/external/periodStatistics?from=12-05-2017&to=12-06-2017

Response example:

{
  "status_code": 200,
  "status_txt": "Success",
  "data": [
    {
      "device_id": "ANDROID-MOTOROLA-A2604A03-886E-4235-931E-F08A08524717",
      "message_id": "9937",
      "title": "Título",
      "description": "Cuerpo prueba Daniel",
      "platform": "0",
      "sent_at": null,
      "clicked_at": "2017-05-12 09:32:33",
      "button_clicked": "0"
    },
    {
      "device_id": "ANDROID-MOTOROLA-A2604A03-886E-4235-931E-F08A08524717",
      "message_id": "9959",
      "title": "Prueba MF appPush",
      "description": "Prueba MF appPush",
      "platform": "0",
      "sent_at": null,
      "clicked_at": "2017-05-16 16:07:28",
      "button_clicked": "0"
  }]
}

Areas

Endpoint to manage areas.

Create area

Endpoint: HTTP POST api/external/api_area_create

Parameters:

Name type description optional
name string Name of the area. no
latitude float Latitude of the centre of the area. no
longitude float Length of the centre of the area. no
radius number The radius of the area in metres. no

Request example: api/external/api_area_create

{
  "name": "Madrid",
  "latitude": 40.459230,
  "longitude": -3.691189,
  "radius": 30
}

Response example:

{
  "status_code": 200,
  "status_txt": "Entidad Area creada",
  "data": {
    "area": "123"
  }
}

Edit area

Endpoint: HTTP POST api/external/api_area_update

Parameters:

Name type description optional
area_id number ID of the area to edit no
name string Name of the area no
latitude float Latitude of the centre of the area no
longitude float Length of the centre of the area no
radius number The radius of the area in metres no

Request example: api/external/api_area_update

{
  "area_id": 123,
  "name": "Madrid",
  "latitude": 40.459230,
  "longitude": -3.691189,
  "radius": 60
}

Response example:

{
  "status_code": 200,
  "status_txt": "Entidad Area actualizada",
  "data": {
    "area": "123"
  }
}

Delete area

Endpoint: HTTP POST api/external/api_area_delete

Parameters:

Name type description optional
area_id number ID of the area to delete no

Request example: api/external/api_area_delete

Response example:

{
  "status_code": 200,
  "status_txt": "Area delete",
  "data": {
    "area": "123"
  }
}

Devices

Unsubscribed devices

Get a list of unsubscribed devices in the application between two dates.

Endpoint: HTTP GET api/removed_devices

Parámeters:

Name type description optional
date_from Date Date where to start counting no
date_to Date Date to end counting, if omitted, it will be used the actual date si

Request example: api/removed_devices?app_token=XXXXXX&access_token=XXXXXXX&date_from=20170306

Response example:

{
  "status_code": 200,
  "status_txt": "Lista de dispositivos eliminados",
  "data": [
    "1131a5f5c3bc9c849b2f225297943465",
    "129c6632c041824e1199511f2619d339",
    "33b593131de3b430309d461af27d112b",
    "3743792445a31262cd17121491682462",
  ]
}

Remote configuration of the SDK

This endpoint allows you to change certain behaviours of the SDK instantly, without the need to republish in the markets.

Currently, only the tracking frequency can be changed, but in future versions more configuration parameters will be added.

Tracking frequency of the devices

Endpoint: HTTP POST api/external/api_update_application_conf

Parameters:

Name type description optional
time_update number Number of minutes to update the position of the devices, the minimum allowable is 5 no minutes and the maximum 99 minutes. By default, 20 minutes. no

Request example: api/external/api_update_application_conf

{
  "time_update": 30
}

Response example:

{
  "status_code": 200,
  "status_txt": "Entidad Application actualizada",
  "data": {
    "application": "my_app",
    "time_update": "20"
  }
}

Appush multiple creation and send

This endpoint is designed to create and send multiple notifications.

Appush interactive action with image

Endpoint to manage notifications with image and selectable options.

Method: POST
Endpoint: api/external/api_push_message_create

Parameters:

Name type description optional
type = 8 number Type “with image” to appPush No
buttonIcon = 11 number “Interactive” action to appPush No
os = 10 number Send only to a mobile app No
title string Message tittle text to iOS10+ and Android No
description string Message Body text to iOS10+ and Android No
titleIos string Message Body text to iOS9 and previous No
wallpaper_thumb string Image url No
iosCategory = 1 number Required param to interactive appush No
text string Button text 1 (Yes) tied to url1 No
button string Button text 2 (No) tied to url2 No
url1 string Website that will be open when button 1 is clicked No
url2 string Website that will be open when button 2 is clicked No

Request example: api/external/api_push_message_create

{
"app_token": "APP_TOKEN",
"access_token": "ACCESS_TOKEN",
"type": 8,
"title": "Test title MF appPush",
"description": "Test body MF appPush",
"titleIos": "Test body MF appPush",
"wallpaper_thumb": "https://pruebas.indigitall.net/bundles/smart2mebackend/images/logo/azul_l.png",
"buttonIcon": 11,
"url1": "https://indigitall.net",
"url2": "https://indigitall.net",
"os": 10,
"text": "Yes",
"button": "No",
"iosCategory": 1
}

Response example:

{
    "status_code": 200,
    "status_txt": "Entidad Message creada",
    "data": {
        "message_id": 1507665
    }
}

Appush interactive action without image

Endpoint to manage notifications without image and selectable options.

Method: POST
Endpoint: api/external/api_push_message_create

Parameters:

Nombre tipo descripción opcional
type = 11 number “Interactive without image” type to appPush No
os = 10 number Send only to mobile app No
title string Message tittle text to iOS10+ and Android No
description string Message Body text to iOS10+ y Android No
titleIos string Message Body text to iOS9 and previous No
iosCategory = 1 number Required param to interactive appush No
text string Button text 1 (Yes) tied to url1 No
button string Button text 2 (No) tied to url2 No
url1 string Website that will be open when button 1 is clicked No
url2 string Website that will be open when button 2 is clicked No

Request example: api/external/api_push_message_create

{
"app_token": "APP_TOKEN",
"access_token": "ACCESS_TOKEN",
"type": 11,
"title": "Test title MF appPush",
"description": "Test body MF appPush",
"titleIos": "Test body MF appPush",
"url1": "https://indigitall.net",
"url2": "https://indigitall.net",
"os": 10,
"text": "Yes",
"button": "No",
"iosCategory": 1
}

Response example:

{
    "status_code": 200,
    "status_txt": "Entidad Message creada",
    "data": {
        "message_id": 1507666
    }
}

Appush open application action with image

Endpoint to manage notifications with image and app link.

Method: POST
Endpoint: api/external/api_push_message_create

Parameters:

Name type description optional
type = 8 number “With image” type to appPush No
buttonIcon = 6 number “Open app” action to appPush No
os = 10 number Send only to mobile app No
title string Message tittle text to iOS10+ and Android No
description string Message Body text to iOS10+ y Android No
titleIos string Message Body text to iOS9 and previous No
wallpaper_thumb string Image url No
text string Lower area title (to SDK Indigitall before v2.2.0 Android and v2.0.0 iOS) No
button string Lower area button text (to SDK Indigitall before v2.2.0 Android and v2.0.0 iOS) No
uri string Custom parameters received by the application No

Request example: api/external/api_push_message_create

{
"app_token": "APP_TOKEN",
"access_token": "ACCESS_TOKEN",
"type": 8,
"title": "Test title MF appPush",
"description": "Test body MF appPush",
"titleIos": "Test body MF appPush",
"wallpaper_thumb": "https://pruebas.indigitall.net/bundles/smart2mebackend/images/logo/azul_l.png",
"buttonIcon": 6,
"os": 10,
"text": "Texto de Prueba MF appPush",
"button": "Abrir",
"uri": "https://indigitall.net"
}

Response example:

{
    "status_code": 200,
    "status_txt": "Entidad Message creada",
    "data": {
        "message_id": 1507668
    }
}

Appush open application action without image

Endpoint to manage notifications without image and app link.

Method: POST
Endpoint: api/external/api_push_message_create

Parameters:

Name type description optional
type = 9 number “Without image” type to appPush No
os = 10 number Send only to mobile app No
title string Message tittle text to iOS10+ and Android No
description string Message Body text to iOS10+ and Android No
titleIos string Message Body text to iOS9 and previous No
uri string Custom parameters received by the application No

Request example: api/external/api_push_message_create

{
"app_token": "APP_TOKEN",
"access_token": "ACCESS_TOKEN",
"type": 9,
"title": "Test title MF appPush",
"description": "Test body MF appPush",
"titleIos": "Test body MF appPush",
"os": 10,
"uri": "https://indigitall.net"
}

Response example:

{
    "status_code": 200,
    "status_txt": "Entidad Message creada",
    "data": {
        "message_id": 1507670
    }
}

Appush open website action with image

Endpoint to manage notifications with image and website link.

Method: POST
Endpoint: api/external/api_push_message_create

Parameters:

Name type description optional
type = 8 number “With image” type to appPush No
buttonIcon = 4 number “Open app” action to appPush No
os = 10 number Send only to mobile app No
title string Message tittle text to iOS10+ and Android No
description string Message Body text to iOS10+ and Android No
titleIos string Message Body text to iOS9 and previous No
wallpaper_thumb string Image url No
text string Lower area title (to SDK Indigitall before v2.2.0 Android and v2.0.0 iOS) No
button string Lower area button text (to SDK Indigitall before v2.2.0 Android and v2.0.0 iOS) No
uri string Custom parameters received by the application No

Request example: api/external/api_push_message_create

{
"app_token": "APP_TOKEN",
"access_token": "ACCESS_TOKEN",
"type": 8,
"title": "Test title MF appPush",
"description": "Test body MF appPush",
"titleIos": "Test body MF appPush",
"wallpaper_thumb": "https://pruebas.indigitall.net/bundles/smart2mebackend/images/logo/azul_l.png",
"buttonIcon": 4,
"os": 10,
"text": "Texto de Prueba MF appPush",
"button": "Abrir",
"uri": "https://indigitall.net"
}

Response example:

{
    "status_code": 200,
    "status_txt": "Entidad Message creada",
    "data": {
        "message_id": 1507671
    }
}

Appush open website action without image

Endpoint to manage notifications without image and website link.

Method: POST
Endpoint: api/external/api_push_message_create

Parameters:

Name type description optional
type = 4 number “Without image” type to appPush No
os = 10 number Send only to mobile app No
title string Message tittle text to iOS10+ and Android No
description string Message body text to iOS10+ and Android No
titleIos string Mensage body text to iOS9 and previous No
uri string Custom parameters received by the application No

Request example: api/external/api_push_message_create

{
"app_token": "APP_TOKEN",
"access_token": "ACCESS_TOKEN",
"type": 4,
"title": "Test title MF appPush",
"description": "Test body MF appPush",
"titleIos": "Test body MF appPush",
"os": 10,
"uri": "https://indigitall.net"
}

Response example:

{
    "status_code": 200,
    "status_txt": "Entidad Message creada",
    "data": {
        "message_id": 1507672
    }
}