Push Configuration
Create and manage application configurations for receiving messages.
Other than sending messages, our platform fully supports the reception of incoming messages from your users. Configuration and Action setup will enable you to achieve that.
Receiving Push messages
Configuration and Action setup must be completed before you start using the Receive Push messages method.
Configuration is a logical container for Actions. You can choose a method of incoming message delivery through the Action setup, but before you do that, Configuration must be created since the Action can only exist inside of the Configuration container.
Important
A Configuration container must be created after the Application setup and before the Action setup.
Available methods:
- List all configurations
- Get a single configuration
- Create a new configuration
- Delete the configuration
List all configurations
This method allows you to get your app configurations.
https://api.infobip.com/push/1/applications/{applicationCode}/configurations
Path params
| Parameter | Type | Default value | Description |
|---|---|---|---|
| applicationCode | string | - | Application code |
Request example
GET /push/1/applications/233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53/configurations HTTP/1.1
Host: api.infobip.com
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Response
{
"configurations":[
{
"key": "CB0F6CEC031D81116AB72720C1765A9D",
}
]
}
If successful , the response header HTTP status code will be 200 OK.
| Parameter | Type | Description |
|---|---|---|
| configurations | String | List or configurations. |
| key | String | Configuration key. |
In case of an error, you will receive an error response status code in the header and the response body will contain an error object. If you try to create an application when you do not have the user’s authorization, you will receive a 401 Unauthorized error.
Get a single configuration
This method allows you to get a configuration for your application.
https://api.infobip.com/push/1/applications/{applicationCode}/configurations/{configurationKey}
Path params
| Parameter | Type | Default value | Description |
|---|---|---|---|
| applicationCode | string | - | Application code |
| configurationKey | string | - | Configuration key |
Request example
GET /push/1/applications/233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53/configurations/CB0F6CEC031D81116AB72720C1765A9D HTTP/1.1
Host: api.infobip.com
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Response
{
"key": "CB0F6CEC031D81116AB72720C1765A9D"
}
If successful, the response header HTTP status code will be 200 OK.
| Parameter | Type | Description |
|---|---|---|
| key | String | Configuration key. |
In case of an error, you will receive an error response status code in the header and the response body will contain an error object. If you try to create an application when you do not have the user’s authorization, you will receive a 401 Unauthorized error.
Create a new configuration
This method allows you to create a configuration.
https://api.infobip.com/push/1/applications/{applicationCode}/configurations
Path params
| Parameter | Type | Default value | Description |
|---|---|---|---|
| applicationCode | string | - | Application code |
Request example
POST /push/1/applications/233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53/configurations HTTP/1.1
Host: api.infobip.com
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Response
{
"key": "CB0F6CEC031D81116AB72720C1765A9D"
}
If successful, the response header HTTP status code will be 200 OK.
| Parameter | Type | Description |
|---|---|---|
| key | String | Configuration key. |
In case of an error, you will receive an error response status code in the header and the response body will contain an error object. If you try to create a configuration when you do not have the user’s authorization, you will receive a 401 Unauthorized error. Attempting to create a new configuration when another configuration already exists will result in the 409 CONFLICT status.
Delete the configuration
This method allows you to delete the configuration.
https://api.infobip.com/push/1/applications/{applicationCode}/configurations/{configurationKey}
Path params
| Parameter | Type | Default value | Description |
|---|---|---|---|
| applicationCode | string | - | Application code |
| configurationKey | string | - | Configuration key |
Request example
DELETE /push/1/applications/233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53/configurations/CB0F6CEC031D81116AB72720C1765A9D
Host: api.infobip.com
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
If successful, the response header HTTP status code will be 204 No Content.
In case of an error, you will receive an error response status code in the header and the response body will contain an error object. If you try to create an application when you do not have the user’s authorization, you will receive a 401 Unauthorized error.