INTRODUCTION
This guide provides a comprehensive reference for configuring Action URLs and supported variables on Grandstream WP8x6 series Wi-Fi phones. It is intended for system administrators who want to trigger external HTTP events based on specific phone actions or statuses.
The WP8x6 phone can be configured to send an HTTP GET request (Action URL) with dynamic variables substituted based on the phone’s current state or triggered event.
WEB UI CONFIGURATION
On the WP8x6 phone Web UI, users can configure Action URLs from Maintenance → Outbound Notification → Action URL.
Each event in this tab allows users to define a specific URL to be triggered when the corresponding state or action occurs. These events include:
Phone Status Events
The phone status events provide information about the registration and network state of the WP8x6 phone.
- Setup Completed: The initial configuration process has successfully finished.
- Registered: The phone has successfully registered to the SIP server.
- Deregistered: The phone has unregistered or lost registration.
- Register Failed: An attempt to register the phone failed.
- Idle to Busy: Phone transitioned from idle to busy (e.g., call started).
- Busy to Idle: Phone transitioned from busy to idle (e.g., call ended).
- Auto Provision Completed: An automatic provisioning attempt completed successfully.
- IP Change: The device’s IP address changed.
Call Operation Events
This section describes call operation events related to all actions and transitions during call handling.
- Incoming Call: A call is incoming to the phone.
- Outgoing Call: A call is initiated from the phone.
- Missed Call: A call was not answered.
- Established Call: A call was successfully connected.
- Forwarded Call: A call was redirected via call forwarding rules.
- Terminated Call: A call was ended (hang-up or disconnect).
- Answered Call: A call was answered.
- Rejected Call: A call was actively declined.
- Blind Transfer: A call was transferred without consultation.
- Attended Transfer: A call was transferred with consultation.
- Transfer Completed: A transfer completed successfully.
- Transfer Failed: A transfer attempt failed.
- Hold Call: A call was placed on hold.
- Unhold Call: A call was resumed from hold.
- Mute Call: The microphone was muted.
- Unmute Call: The microphone was unmuted.
Call Settings Events
These events reflect toggles in user-level call configuration settings.
- Enable DND: Do Not Disturb mode was enabled.
- Disable DND: Do Not Disturb mode was disabled.
- Enable Call Forward: Global call forward was enabled.
- Disable Call Forward: Global call forward was disabled.
- Open Forward Always: Unconditional Call Forward was enabled.
- Close Forward Always: Unconditional Call Forward was disabled.
- Open Call Forward Busy: Busy Call Forward was enabled.
- Close Call Forward Busy: Busy Call Forward was disabled.
- Open Call Forward No Answer: No Answer Call Forward was enabled.
- Close Call Forward No Answer: No Answer Call Forward was disabled.
Hardware Settings Events
These hardware-related events indicate changes in the WP8x6 system health.
- Abnormal CPU Temperature: CPU temperature exceeded safe thresholds.
- Normal CPU Temperature: CPU temperature returned to safe thresholds.
- Abnormal Battery Temperature: Battery temperature status changed to abnormal state.
- Normal Battery Temperature: Battery temperature status changed to normal state.
- Low Battery: Battery charge level dropped below configured threshold.
- Sufficient Battery: Battery charge level rose above configured threshold.
- Abnormal Battery Voltage: Voltage readings are abnormal.
- Normal Battery Voltage: Voltage readings are normalized.
Alarm Settings Events
Alarm settings relate to triggered alarm events for the WP8x6 phone and their resolution.
- Alarm: An alarm condition has been triggered.
- Alarm Ended: The alarm condition has cleared.
ACTION URL SYNTAX
When an event occurs, the phone sends an HTTP GET request to a configured URL like this:
http://<your_server>:<port>/ip=$phone_ip&mac=$mac&product=$product
- Each event can be assigned a URL containing dynamic variables.
- When the event triggers, the variables are replaced with actual data.
- Variable placeholders support both $param and {param} formats.
- Parameters are not case sensitive.
Only Action URL events support dynamic variables. The Destination and Notification tabs under Maintenance → Outbound Notification allow alert messaging via SMTP/XMPP but do not support variables. They are therefore excluded from this guide.
SUPPORTED VARIABLES
This section categorizes and explains all supported outbound variables that can be used in Action URLs for WP8x6 series devices. These variables are automatically replaced by the device with real-time values during event triggers.
Common Device Parameters
Parameter | Description |
phone_ip | Device IP address |
mac | MAC address in format 10:7B:44:80:F4:6A |
macAddress | MAC address (no separators), e.g., 107b4480f46a |
product / model | Device model number |
program_version | Device firmware version |
language | Language currently in use |
label | Custom tag/label for the device |
timestamp | Timestamp |
battery | Battery level |
Phone Status
Web Login/Logout
Parameter | Description |
eventName | Event name triggered |
OAMUser | Username for login/logout event |
OAMLoginSource | Source of login |
time | Operation time |
OAMLoginCode | Result of login attempt |
Setup Completed/Idle/Busy Changes/Auto Provisioning/IP Change
Parameter | Description |
eventName | Event name triggered |
Unregistered
Parameter | Description |
eventName | Event name triggered |
account | Account ID |
registerStatus | Registration status |
changed | Whether a change occurred (always true) |
time | Event time |
auEventName | Alternative event name format |
accountName | Account display name |
number | SIP user ID |
sipServer | Registration server address |
sipIp | Server IP address |
Registration Failed
Parameter | Description |
eventName | Event name triggered |
account | Account ID |
accountName | Account display name |
number | SIP user ID |
registerStatus | Registration status |
sipServer | Registration server address |
Call Operation
Common Parameters
Parameter | Description |
local / localNumber | Local Account |
display_local / localName | Local account name |
remote / remoteNumber | Remote display account |
display_remote / remoteName | Remote Display Name |
call-id | Call call-id |
active_user / account | Account ID |
Incoming/Outgoing/Established/Answered/Rejected/Terminated/Transfer/Hold/Resume
Parameter | Description |
eventName | Event Name |
status | Call Status |
line | Call Line |
account | Call account index |
message | Call error message |
remoteInitNumber | Remote original number (unprocessed for display) |
RemoteInitName | Remote original name (unprocessed for display) |
localNumber | Local Account |
localName | Local account name |
sipServer | Account registration server address |
isMulticast | Whether to multicast the call |
divertName | Diverted name, if any |
divertNumber | Diverted number, if any |
isCaller | Whether the user initiated the call |
transferName | Transferring party’s name |
transferNumber | Transferring party’s number |
callType | Type: incoming or outgoing |
callDirection | Direction: in or out |
call-id | Call call-id |
multipleLinesConnected | Whether multiple lines are in use |
isInConf | Conference status |
picture | Placeholder for future use |
startTimeValue | Start time (timestamp) |
startTime | Start time |
duration | Talk time |
timeValue | Event time (timestamp) |
time | Event time |
Missed Calls
Parameter | Description |
eventName | Event Name |
remoteNumber | Remote display number (processed) |
remoteName | Remote display name |
account | Account index |
accountName | Account Name |
localName | Local account name |
localNumber | SIP user ID |
startTimeValue | Start time (timestamp) |
StartTime | Start time |
duration | Ringing duration |
schema | Special flags (e.g., rejected, missed) |
timeValue | Event timestamp |
time | Event time |
call-id | Call ID |
Mute/Unmute
Parameter | Description |
eventName | Event name triggered |
mute | Mute status: ON/OFF |
auEventName | Event name: AU_Mute/AU_UnMute |
Call Settings
DND (Do Not Disturb) On/Off
Parameter | Description |
eventName | Event name triggered |
status | DND status: on/off |
auEventName | Event name: AU_DND_ON/AU_DND_OFF |
Call Forwarding On/Off
Parameter | Description |
eventName | Event name triggered |
account | Account ID/index |
forwardNumberAll | Forward all number |
forwardNumberBusy | Forward if busy number |
forwardNumberNoAns | Forward if no answer number |
Hardware Settings
CPU Temperature
Parameter | Description |
eventName | Event Name |
label | Custom label |
temp | CPU temperature |
time | Time of event |
Battery & Voltage
Parameter | Description |
eventName | Event Name |
label | Custom label |
temp | Battery temperature |
voltage | Battery voltage |
level | Battery level |
time | Time of event |
Alarm Settings
Parameter | Description |
eventName | Event Name |
model | Device model |
Mac | MAC address |
phone_ip | Device IP |
localName | Local account name |
localNumber | SIP user ID |
EmergencyNumber | Alarm call number |
country | Country (IP-based) |
region | Region (IP-based) |
city | City (IP-based) |
longtitude | Longitude (IP-based) |
latitude | Latitude (IP-based) |
event | Alarm trigger event |
startTime | Alarm start time |
duration | Alarm duration |
endTime | Alarm end time |
SUPPORTED DEVICES
Supported Devices | Firmware Version |
WP816 | 1.0.1.9+ |
WP826 | 1.0.1.9+ |
WP836 | 1.0.1.9+ |