{
  "opencollection": "1.0.0",
  "info": {
    "name": "Infobip OpenAPI Specification",
    "version": "3.210.0"
  },
  "items": [
    {
      "info": {
        "name": "channels",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Send single Push notification",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/push/2/message/single",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Use this method to send a single Push notification to one or multiple recipients."
        },
        {
          "info": {
            "name": "Send multiple Push notifications",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/push/2/message/multi",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Use this method when sending a large amount of messages or targeting different user segments with different messages to optimize data traffic and increase performance."
        },
        {
          "info": {
            "name": "Send Push notifications",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/push/3/messages",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "This method allows you to send Push notifications to a recipient or multiple recipients in one request."
        },
        {
          "info": {
            "name": "Get push applications",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/push/1/applications",
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "The following method allows you to fetch all application profiles configured on a single account."
        },
        {
          "info": {
            "name": "Get push Application by applicationCode",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/push/1/applications/:applicationCode",
            "params": [
              {
                "name": "applicationCode",
                "value": "",
                "type": "path",
                "description": "Application code."
              },
              {
                "name": "useAppCodeAsAppId",
                "value": "",
                "type": "query",
                "description": "Set to true to treat application code as application ID."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "The following method allows you to fetch information about a specific application profile."
        },
        {
          "info": {
            "name": "Get Push statistics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/push/1/statistics",
            "params": [
              {
                "name": "bulkId",
                "value": "",
                "type": "query",
                "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "The following method allows you to retrieve statistics for a specific bulk of sent Push messages."
        },
        {
          "info": {
            "name": "Get Push reports",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/push/1/reports",
            "params": [
              {
                "name": "bulkId",
                "value": "23568941",
                "type": "query",
                "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request."
              },
              {
                "name": "messageId",
                "value": "ff4804ef-6ab6-4abd-984d-ab3b1387e852",
                "type": "query",
                "description": "The ID of the individual message for which the report is requested."
              },
              {
                "name": "limit",
                "value": "1",
                "type": "query",
                "description": "Maximum number of reports."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "This method allows you to get one-time delivery reports for sent Push messages. You can only fetch reports that are no older than 48 hours."
        },
        {
          "info": {
            "name": "Receive MO Push messages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/push/1/inbox/reports",
            "params": [
              {
                "name": "limit",
                "value": "2",
                "type": "query",
                "description": "Maximum number of received messages to return."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Get MO (Mobile Originated) Push messages that have been received by the Infobip platform from your subscribers' devices. These are incoming messages sent from devices to your application, not messages sent from the platform to devices. Each request will return a batch of received messages - only once. The following request will return the next batch of messages."
        },
        {
          "info": {
            "name": "Get Push delivery reports",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/push/3/reports",
            "params": [
              {
                "name": "bulkId",
                "value": "",
                "type": "query",
                "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address."
              },
              {
                "name": "messageId",
                "value": "",
                "type": "query",
                "description": "The ID that uniquely identifies the message sent."
              },
              {
                "name": "limit",
                "value": "1",
                "type": "query",
                "description": "Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h"
              },
              {
                "name": "entityId",
                "value": "promotional-traffic-entity",
                "type": "query",
                "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)."
              },
              {
                "name": "applicationId",
                "value": "marketing-automation-application",
                "type": "query",
                "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)."
              },
              {
                "name": "campaignReferenceId",
                "value": "summersale",
                "type": "query",
                "description": "ID of a campaign that was sent in the message."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once."
        },
        {
          "info": {
            "name": "Get Push message logs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/push/3/logs",
            "params": [
              {
                "name": "sender",
                "value": "",
                "type": "query",
                "description": "The sender ID which can be alphanumeric or numeric."
              },
              {
                "name": "destination",
                "value": "",
                "type": "query",
                "description": "Message destination address."
              },
              {
                "name": "bulkId",
                "value": "BULK-ID-123-xyz",
                "type": "query",
                "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters."
              },
              {
                "name": "messageId",
                "value": "MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz",
                "type": "query",
                "description": "Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters."
              },
              {
                "name": "generalStatus",
                "value": "",
                "type": "query"
              },
              {
                "name": "sentSince",
                "value": "2020-02-22T17:42:05.390+01:00",
                "type": "query",
                "description": "The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
              },
              {
                "name": "sentUntil",
                "value": "2020-02-23T17:42:05.390+01:00",
                "type": "query",
                "description": "The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h."
              },
              {
                "name": "entityId",
                "value": "promotional-traffic-entity",
                "type": "query",
                "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)."
              },
              {
                "name": "applicationId",
                "value": "marketing-automation-application",
                "type": "query",
                "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)."
              },
              {
                "name": "campaignReferenceId",
                "value": "summersale",
                "type": "query",
                "description": "ID of a campaign that was sent in the message. May contain multiple comma-separated values."
              },
              {
                "name": "useCursor",
                "value": "",
                "type": "query",
                "description": "Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours."
        },
        {
          "info": {
            "name": "List all configurations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/push/1/applications/:applicationCode/configurations",
            "params": [
              {
                "name": "applicationCode",
                "value": "my_app_code",
                "type": "path",
                "description": "Application code identifying the application."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "List all MO (Mobile Originated) message configurations for an application."
        },
        {
          "info": {
            "name": "Create a new configuration",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/push/1/applications/:applicationCode/configurations",
            "params": [
              {
                "name": "applicationCode",
                "value": "my_app_code",
                "type": "path",
                "description": "Application code identifying the application."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Create a new MO (Mobile Originated) message configuration for an application."
        },
        {
          "info": {
            "name": "Get a single configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/push/1/applications/:applicationCode/configurations/:configurationKey",
            "params": [
              {
                "name": "applicationCode",
                "value": "my_app_code",
                "type": "path",
                "description": "Application code identifying the application."
              },
              {
                "name": "configurationKey",
                "value": "config_key",
                "type": "path",
                "description": "Configuration key identifying the configuration."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Get a single MO (Mobile Originated) message configuration by key."
        },
        {
          "info": {
            "name": "Delete the configuration",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/push/1/applications/:applicationCode/configurations/:configurationKey",
            "params": [
              {
                "name": "applicationCode",
                "value": "my_app_code",
                "type": "path",
                "description": "Application code identifying the application."
              },
              {
                "name": "configurationKey",
                "value": "config_key",
                "type": "path",
                "description": "Configuration key identifying the configuration."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Delete an MO (Mobile Originated) message configuration by key."
        },
        {
          "info": {
            "name": "List all actions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/push/1/applications/:applicationCode/configurations/:configurationKey/actions",
            "params": [
              {
                "name": "applicationCode",
                "value": "my_app_code",
                "type": "path",
                "description": "Application code identifying the application."
              },
              {
                "name": "configurationKey",
                "value": "config_key",
                "type": "path",
                "description": "Configuration key identifying the configuration."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "List all actions for an MO (Mobile Originated) message configuration."
        },
        {
          "info": {
            "name": "Create new action",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/push/1/applications/:applicationCode/configurations/:configurationKey/actions",
            "params": [
              {
                "name": "applicationCode",
                "value": "my_app_code",
                "type": "path",
                "description": "Application code identifying the application."
              },
              {
                "name": "configurationKey",
                "value": "config_key",
                "type": "path",
                "description": "Configuration key identifying the configuration."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Create a new action for an MO (Mobile Originated) message configuration. Supported action types are HTTP_FORWARD and PULL."
        },
        {
          "info": {
            "name": "Delete action",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/push/1/applications/:applicationCode/configurations/:configurationKey/actions/:actionKey",
            "params": [
              {
                "name": "applicationCode",
                "value": "my_app_code",
                "type": "path",
                "description": "Application code identifying the application."
              },
              {
                "name": "configurationKey",
                "value": "config_key",
                "type": "path",
                "description": "Configuration key identifying the configuration."
              },
              {
                "name": "actionKey",
                "value": "action_key",
                "type": "path",
                "description": "Action key identifying the action to delete."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Delete an action from an MO (Mobile Originated) message configuration."
        },
        {
          "info": {
            "name": "Delete Push Inbox messages",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/push/1/inbox/messages",
            "params": [
              {
                "name": "campaignId",
                "value": "100004815162342",
                "type": "query",
                "description": "`campaignId` of messages that you'd like to delete."
              },
              {
                "name": "bulkId",
                "value": "fe40d1aa-b4ec-11ec-b909-0242ac120002",
                "type": "query",
                "description": "`bulkId` of messages that you'd like to delete."
              },
              {
                "name": "messageId",
                "value": "1738833000000",
                "type": "query",
                "description": "`messageId` of the specific message you'd like to delete."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Deletes Push Inbox messages from devices that have a mobile application integrated with the 'Push Inbox'. Beware, this action cannot be undone."
        },
        {
          "info": {
            "name": "Delete Push Inbox message for a specific user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/push/1/user/:externalUserId/inbox/messages",
            "params": [
              {
                "name": "externalUserId",
                "value": "",
                "type": "path",
                "description": "External identifier of the user"
              },
              {
                "name": "campaignId",
                "value": "",
                "type": "query",
                "description": "`campaignId` of message to delete"
              },
              {
                "name": "bulkId",
                "value": "",
                "type": "query",
                "description": "`bulkId` of message to delete"
              },
              {
                "name": "messageId",
                "value": "",
                "type": "query",
                "description": "`messageId` of the specific message to delete"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Deletes a single Push Inbox message from a specific user's inbox. Requires specifying either campaignId or bulkId."
        }
      ]
    }
  ],
  "bundled": true
}