Push API

To use Push API you need to have individual User API token, which can be found in the settings of space.

You’ll see the block with User API token on the space settings page only in case if your tariff plan and access rights allow to use devtodev API. You can reset User API token or create it again on the same page.

Please attend, if you use several spaces, in every space user has individual User API token.

Request format

The request of assignment should be sent to:

https://www.devtodev.com/api/v1/push/send?user_token=USER_API_TOKEN

Where

user_token - individual User API token of a user. It could be sent with both GET and POST methods.
v1 - the current version of API

Request content is sent with POST method in JSON format.

The body of a request can contain the following properties:

An example of a request for sending a simple notification to an iOS device:

https://devtodev.com/api/v1/push/send

POST

{
    "user_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "app_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "campaign_tag": "campaign name",
    "pack_id": "uniqueid1234",
    "audience": [{
        "idfa": "XXXXX-XXXXX-XXXXXX-XXXXXX"
    },
    {
        "idfa": "YYYYY-YYYYY-YYYYYY-YYYYYY"
    }],
    "ios": {
        "payload": {
            "text": "Hello world!"
        },
        "options": {
            "priority": "normal",
            "expire": 36000
        }
    }
}

Response format

If a request is formed correctly and there are no obstacles for sending a notification to users, an answer is JSON of the following type:

{
    "status_code": 200,
    "data": {
        "status": "complete",
        "result": {
            "audience": 100500,
            "successful": 100477,
            "erroneous": 23,
            "error_details": []
        }
    }
}

where

audience (number) - the number of users found
successful (number) - the number of successfully sent notifications
erroneous (number) - the number of notifications rejected by the delivery service
error_details (array) - a detailed description of reasons of a delivery fail

In case there is an error in a request, an answer is made in the following format:

{
    "status_code": 400,
    "errors": [{
        "code": 3,
        "msg": "Error description"
    }]
}

where

status_code (number) - a general status of an error
errors (array) - an array of error descriptions
code (number) - the exact code of an error from the table of errors
msg (string) - a brief description of an error

The list of possible errors is given in a table.

List of possible errors

Besides the errors listed above, error_details field may contain errors from the connected notification services. You can find descriptions of such errors in documentation for these services:

PreviousSubscription API NextIOS

Last updated 1 year ago

{ "user_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "app_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "campaign_tag": "campaign name", "pack_id": "uniqueid1234", "audience": [{ "idfa": "XXXXX-XXXXX-XXXXXX-XXXXXX" }, { "idfa": "YYYYY-YYYYY-YYYYYY-YYYYYY" }], "ios": { "payload": { "text": "Hello world!" }, "options": { "priority": "normal", "expire": 36000 } } }

{ "status_code": 200, "data": { "status": "complete", "result": { "audience": 100500, "successful": 100477, "erroneous": 23, "error_details": [] } } }