Mobile push

List an app push notification

Retrieve a collection of app push notification.

GEThttp://127.0.0.1:8888/api/mobile_push

Query parameters

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/mobile_push', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 100,
  "items": [
    {
      "id": {},
      "app_name": "text",
      "enabled": true
    }
  ]
}

Add App for enabling push notification

Mobile push messages wake up PortSIP Solutions Soft Phone or other Client Apps on mobile device so that a call or Instant Message can be accepted, reducing battery usage and improving reliability Android devices receive push notifications from Firebase Cloud Messaging Server; iOS devices receive push notifications from APNs.

POSThttp://127.0.0.1:8888/api/mobile_push

Body

application/json

app_namestring

Application name.

enabledboolean

Enabled this notification or not.

modeenum

Connect to Apple/Google development push server or production push server:

• PRODUCTION: Connect to Apple/Google production push server.
• DEVELOPMENT: Connect to Apple/Google development push server.

PRODUCTIONDEVELOPMENT

android_service_accountstring

The Firebase Cloud Messaging service account JSON file.

ios_certificatestring

Content of this APNs SSL certificate key file.

ios_private_keystring

Content of this APNs SSL private key file.

Response

2014XX

Created push

Body

application/json

idall of

The unique ID of push profile.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/mobile_push', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "id": {}
}

Retrieve an app push notification.

Retrieve details of app push notification by it's unique ID.

GEThttp://127.0.0.1:8888/api/mobile_push/{id}

Path parameters

id*all of

The unique ID of push profile.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of push profile.

app_namestring

Application name.

enabledboolean

Enabled this notification or not.

modeenum

Connect to Apple/Google development push server or production push server:

• PRODUCTION: Connect to Apple/Google production push server.
• DEVELOPMENT: Connect to Apple/Google development push server.

PRODUCTIONDEVELOPMENT

android_service_accountstring

The Firebase Cloud Messaging service account JSON file.

ios_certificatestring

Content of this APNs SSL certificate key file.

ios_private_keystring

Content of this APNs SSL private key file.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/mobile_push/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": {},
  "app_name": "text",
  "enabled": true,
  "mode": "PRODUCTION",
  "android_service_account": "text",
  "ios_certificate": "text",
  "ios_private_key": "text"
}

Update an app push notification

POSThttp://127.0.0.1:8888/api/mobile_push/{id}

Path parameters

id*all of

The unique ID of push profile.

Body

application/json

app_namestring

Application name.

enabledboolean

Enabled this notification or not.

modeenum

Connect to Apple/Google development push server or production push server:

• PRODUCTION: Connect to Apple/Google production push server.
• DEVELOPMENT: Connect to Apple/Google development push server.

PRODUCTIONDEVELOPMENT

android_service_accountstring

The Firebase Cloud Messaging service account JSON file.

ios_certificatestring

Content of this APNs SSL certificate key file.

ios_private_keystring

Content of this APNs SSL private key file.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/mobile_push/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();