Push Notification

Manage your push notification.

List an app push notification

get

Retrieve a collection of app push notification.

Authorizations
Query parameters
filterstringOptional

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

searchstringOptional

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

orderbystringOptional

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

skipinteger · int32Optional

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

Default: 0
topinteger · int32 · min: 1 · max: 100Optional

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

Default: 100
Responses
200

OK

application/json
get
/mobile_push
GET /api/mobile_push HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Add App for enabling push notification

post

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.

Authorizations
Body
app_namestring · min: 1 · max: 64Optional

Application name.

enabledbooleanOptional

Enabled this notification or not.

Default: true
modestring · enumOptional

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.
Default: PRODUCTIONPossible values:
android_service_accountstringOptional

The Firebase Cloud Messaging service account JSON file.

ios_certificatestringOptional

Content of this APNs SSL certificate key file.

ios_private_keystringOptional

Content of this APNs SSL private key file.

Responses
201

Created push

application/json
post
/mobile_push
POST /api/mobile_push HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 137

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

Retrieve an app push notification.

get

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

Authorizations
Path parameters
idall ofRequired

The unique ID of push profile.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

application/json
get
/mobile_push/{id}
GET /api/mobile_push/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Update an app push notification

post
Authorizations
Path parameters
idall ofRequired

The unique ID of push profile.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Body
app_namestring · min: 1 · max: 64Optional

Application name.

enabledbooleanOptional

Enabled this notification or not.

Default: true
modestring · enumOptional

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.
Default: PRODUCTIONPossible values:
android_service_accountstringOptional

The Firebase Cloud Messaging service account JSON file.

ios_certificatestringOptional

Content of this APNs SSL certificate key file.

ios_private_keystringOptional

Content of this APNs SSL private key file.

Responses
200

OK

No content
post
/mobile_push/{id}
POST /api/mobile_push/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 137

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

Delete an app push notification.

post
Authorizations
Path parameters
idall ofRequired

The unique ID of push profile.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204

No Content

No content
post
/mobile_push/{id}/destroy
POST /api/mobile_push/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousAuto ProvisioningNextRing Groups

Last updated