Mobile push

List an app push notification

Retrieve a collection of app push notification.

get

/mobile_push

Authorizations

Query parameters

filterstring

Use the filter query parameter to retrieve just a subset of a collection.

searchstring

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystring

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32 · default: 0

Use the skip query parameter to set the number of items to skip at the start of a collection.

topinteger · int32 · min: 1 · max: 100 · default: 100

Use the top query parameter to specify the page size of the result set.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/mobile_push' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

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

OK

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.

post

/mobile_push

Authorizations

Body

app_namestring · min: 1 · max: 64

Application name.

enabledboolean · default: true

Enabled this notification or not.

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.

modestring · enum · default: PRODUCTION

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.

Options: PRODUCTION, DEVELOPMENT

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/mobile_push' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "app_name": "text",
    "enabled": true,
    "android_service_account": "text",
    "ios_certificate": "text",
    "ios_private_key": "text",
    "mode": "PRODUCTION"
  }'

201

4XX

201

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created push

Retrieve an app push notification.

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

get

/mobile_push/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of push profile.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/mobile_push/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

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

OK

Update an app push notification

post

/mobile_push/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of push profile.

The unique ID of the resource.

Body

app_namestring · min: 1 · max: 64

Application name.

enabledboolean · default: true

Enabled this notification or not.

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.

modestring · enum · default: PRODUCTION

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.

Options: PRODUCTION, DEVELOPMENT

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/mobile_push/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "app_name": "text",
    "enabled": true,
    "android_service_account": "text",
    "ios_certificate": "text",
    "ios_private_key": "text",
    "mode": "PRODUCTION"
  }'

200

4XX

200

No body

OK