4.1.7 Push notification
- Tomasz Kozierowski
- Piotr Mrozek
Push notification
URL: /pn.ashx
The method allows you to enable or disable push notifications.
- To enable the ability to receive notifications, enter the device token in the dt and dmt parameters.
- To disable the ability to receive notifications, set the dt and dmt parameters to "NULL" (NULL text).
Parameter | Description |
|---|---|
l | Login - login of SIP account |
p | Password - password of SIP account |
dt | Device token - Accepted parameters: string with token or NULL value |
| dmt | Device message token. Accepted parameters: string with token or NULL value |
| t | Device type - device type. Accepted parameters: p or t (p - phone, t - tablet) |
| pp | Push provider - parameters required only for ios and and. Possible value for iOS: avns, and android fcm. If the parameter is missing, the value for ios = avns and for and = fcm is set. |
| dbn | application package name |
It is important to send X-VIPPIE-DEVICE-ID and X-VIPPIE-DEVICE-NAME parameters:
X-VIPPIE-DEVICE-NAME - is the device name example iPhone12,1
X-VIPPIE-DEVICE-ID - is the device UDID
Enable push request with curl:
curl --location --request POST 'https://xxxxxxxxxxxx/emcd/pn.ashx?l=48666666666&p=6dzigiA3SXGY&dt=2edba0f05c66eed9e&dmt=9302457d857da0&pp=avns&dbn=net.voiceserve.rn.rcs&r=VoipSwitch' \ --header 'User-Agent: vippie;ios;1.2.3' \ --header 'Content-Type: text/plain' \ --header 'Authorization: Basic aW9zOkxsM0pYNGc3N2ozQXE=' \ --header 'X-VIPPIE-DEVICE-ID: 8AD8E161EA94D14049E5C041D414B98B' \ --header 'X-VIPPIE-DEVICE-NAME: iPhone9,3' |
|---|
2024-07-02 13:59:18,404 54.86.50.139 48600355361 B7F39E5BCAB7FB9A7DDA11AF DEBUG PushNotificationHandler - User-Agent:vippie;ios;1.2.3
2024-07-02 13:59:18,406 54.86.50.139 48600355361 B7F39E5BCAB7FB9A7DDA11AF DEBUG PushNotificationHandler - X-VIPPIE-DEVICE-ID:8AD8E161EA94D14049E5C041D414B98B, X-VIPPIE-DEVICE-NAME:iPhone9,3
2024-07-02 13:59:18,690 54.86.50.139 48600355361 B7F39E5BCAB7FB9A7DDA11AF INFO PushNotificationHandler < 200|text/html|200
Disable push:
We will receive a code in response. The list of possible codes is below.
Code | Description |
|---|---|
200 | OK |
400 | Incorrect parameters - one of the parameters was not provided |
403 | Invalid HTTP method - only POST method accepted |
406 | The login and/or password are incorrect |
500 | Internal server error |
Payload
payload for incoming call
{
"aps": {
"alert": {
"loc-key": "ic",
"loc-args": [„contact name"],
"action-loc-key": "a"
},
"sound": "ic.caf"
},
"ci": "TohFujZgkk;to-tag=1802551547143984;from-tag=szNrNc9qeBataga30",
"cl": „1234567890",
"ct": "a"
}
loc-key - ic - incoming call
loc-args - contact name or phone number
action-loc-key - a - answer
sound - file name
ci - call info
cl - caller ID
ct - call type: a - audio, v - video
payload for missing call
{
"aps": {
"alert": {
"loc-key": "mc",
"loc-args": ["contact name"],
"action-loc-key": "a"
},
"sound": "pn.caf"
},
"cl": "48888035165",
"cdn": "48888035165"
}
loc-key - mc - missing call
loc-args - contact name or phone number
action-loc-key - a - answer
sound - file name
cl - caller ID - sip login
cdn - caller display name
payload for message
{
"aps": {
"alert": {
"loc-key": "tm",
"loc-args": ["contact name", "message body"],
"action-loc-key": "a"
},
"sound": "tm.caf"
},
"cl": „1234567890",
"cdn": „0987654321"
}
loc-key:
- tm - text message,
- vm - video message
- gm - graphic message
- am - audio message
- lm - location
- gc_ng - group chat - new group
- gc_tm - group chat - text message,
- gc_vm - group chat - video message
- gc_vm - group chat - video message
- gc_gm - group chat - graphic message
- gc_am - group chat - audio message
- lm - group chat - location
loc-args - contact name or phone number and message body for text message
action-loc-key - a - answer
sound - file name
cl - caller ID - sip login
cdn - caller display name
payload for voicemail
{
"aps": {
"alert": {
"loc-key": "vn",
"loc-args": ["972542016667", "voice"],
"action-loc-key": "a"
},
"sound": "pn.caf"
},
"cl": "972542016667"
}
loc-key: vm - voicemail
loc-args - contact name or phone number and type: voice or video
action-loc-key - a - answer
sound - file name
cl - caller ID - sip login