Brekeke SIP Server Wiki

Device Registration

For manually registering a device, use following variables in Dial Plan’s Deploy Patterns. If an application sets app-id, pn-type and pn-tok in the Contact header of a REGISTER, Brekeke SIP Server (or bundled SIP server for PBX) will register the device automatically.

&pn.reg.user   (required)
User name for the device registration

&pn.reg.service  (required)
Service ID (1=APNS,2=GCM)

&pn.reg.app  (required)
Application ID

&pn.reg.device  (required)
Device Token for APNS (32 byte hex string). Registration ID for GCM.

&pn.reg.counter 
For APNS’s “badge” key.

&pn.reg.sound
For APNS’s “sound” key.

 

Send Notification

For sending a push notification message to the user, use following variables in Dial Plan’s Deploy Patterns. If the total size of payload exceeds 256 bytes, the message will not be sent.

&pn.notify.user   (required)
User name. Multiple user names can be set by using comma-separated value.

&pn.notify.message   (required)
Message

&pn.notify.title 
For APNS’s “title” key.　Apple Watch displays this value. (for iOS 8.2 or later)

&pn.notify.button
For APNS’s “action-loc-key” key.

&pn.notify.sound
For APNS’s “sound” key.

&pn.notify.image
For APNS’s “launch-image” key.

&pn.notify.expires
Message’s expiration time. The value is a number indicating seconds.

&pn.notify.counter
For APNS’s “badge” key.

&pn.notify.priority
10=high to 1=low

&pn.notify.category
For APNS’s Category Identifier (for iOS 8 or later)

&pn.notify.pushtype
For APNS’s “apns-push-type” header (for iOS 13 or later)

&pn.notify.custom
Custom payload. The value should be JSON data.