> For the complete documentation index, see [llms.txt](https://docs.spectralink.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.spectralink.net/amie-essentials/applications/web-api.md).

# Web API

![](https://3032864282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxfLF6IpyutR429bMnvvf%2Fuploads%2Fgit-blob-64a0f39b274f1d59b5daa34e30308e9af278a731%2Fimage192.png?alt=media)

Web API allows you to configure Versity smartphones to integrate with a Web application.

## Web API

![](https://3032864282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxfLF6IpyutR429bMnvvf%2Fuploads%2Fgit-blob-f6208a656855abe3590ef6e9ec3eec1705bcdf80%2Fimage193.png?alt=media)

### Enable API

You can control which smartphones use the application by enabling or disabling by individual smartphone, group, or enterprise.

**Entry criteria**

|               |                                                 |
| ------------- | ----------------------------------------------- |
| **Type**      | Radio button                                    |
| **Default**   | Disabled                                        |
| **Unique?**   | No                                              |
| **Required?** | See above                                       |
| **Level**     | Enterprise usually, but may be set at any level |
| **Notes**     | See above                                       |

### Enable Web Access

**Entry criteria**

|           |                                                  |
| --------- | ------------------------------------------------ |
| Type      | Radio button                                     |
| Default   | Disabled                                         |
| Unique?   | No                                               |
| Required? | See above                                        |
| Level     | Enterprise usually, but may be set at any level. |
| Notes     |                                                  |

### Data Format

XML and JSON are the supported formats.

**Entry criteria**

|               |                                                 |
| ------------- | ----------------------------------------------- |
| **Type**      | Dropdown menu                                   |
| **Default**   | XML                                             |
| **Unique?**   | No                                              |
| **Required?** | See above                                       |
| **Level**     | Enterprise usually, but may be set at any level |
| **Notes**     | See above                                       |

### Phone State Polling

![](https://3032864282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxfLF6IpyutR429bMnvvf%2Fuploads%2Fgit-blob-2ba84113e9b1a35731c2d36dfa49e8ccfa839d06%2Fimage194.png?alt=media)

#### Username/Password

Enter the username that the smartphone requires to authenticate polling.

Enter the password that the smartphone requires to authenticate polling.

**Entry criteria**

|               |                                                 |
| ------------- | ----------------------------------------------- |
| **Type**      | Text fields                                     |
| **Default**   | None                                            |
| **Unique?**   | No                                              |
| **Required?** | No                                              |
| **Level**     | Enterprise usually, but may be set at any level |
| **Notes**     | See above                                       |

#### Respond Mode

Select the method for sending the requested polling data, either URL or Requester.

If the response method is requester, the response will be sent to the HTTP server running at the address where the request was made. If the response method is URL, you must enter the URL of a valid HTTP server that will get the response. This can be at a different address than the requester.

**Entry criteria**

|               |                                                 |
| ------------- | ----------------------------------------------- |
| **Type**      | Dropdown menu                                   |
| **Default**   | Requester                                       |
| **Unique?**   | No                                              |
| **Required?** | See above                                       |
| **Level**     | Enterprise usually, but may be set at any level |
| **Notes**     | See above                                       |

#### URL

The URL that will receive the polling response.

**Entry criteria**

|               |                                                 |
| ------------- | ----------------------------------------------- |
| **Type**      | Text field                                      |
| **Default**   | None                                            |
| **Unique?**   | No                                              |
| **Required?** | No                                              |
| **Level**     | Enterprise usually, but may be set at any level |
| **Notes**     | See above                                       |

### Push Settings

![](https://3032864282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxfLF6IpyutR429bMnvvf%2Fuploads%2Fgit-blob-366478da4e4db37a7026a605c1264a206b0297ed%2Fimage195.png?alt=media)

#### Username / Push Password

These credentials are for the Web API and are needed to do any kind of push.

**Entry criteria**

|               |                                                 |
| ------------- | ----------------------------------------------- |
| **Type**      | Text fields                                     |
| **Default**   | None                                            |
| **Unique?**   | No                                              |
| **Required?** | Yes, for a push                                 |
| **Level**     | Enterprise usually, but may be set at any level |
| **Notes**     | See above                                       |

#### *Push Alert Priority*

Select the priority desired for messages from the App.

Messages pushed that are below this level of priority will not be displayed on the configured smartphones.

**Entry criteria**

|               |                                                   |
| ------------- | ------------------------------------------------- |
| **Type**      | Dropdown menu                                     |
| **Default**   | All                                               |
| **Unique?**   | No                                                |
| **Required?** | See above                                         |
| **Level**     | Enterprise usually, but may be set at any level   |
| **Notes**     | See *Versity* *Applications Administration Guide* |

#### *Server Root URL*

The URL of the application server you enter here is combined with the smartphone address and sent to the smartphone’s browser. For example, if the application server root URL is [*http://172.24.128.85:8080/sampleapps*](http://supportdocs.polycom.com/PolycomService/support/global/documents/support/technical/products/voice/Syslog_TB17124.pdf) and the relative URL is */examples/sample.html*, the URL that is sent to the web browser on the smartphone is [*http://172.24.128.85:8080/sampleapps/example*](http://tools.ietf.org/html/rfc4510)*s/sample.html*. Can be either HTTP or HTTPS.

**Entry criteria**

|               |                                                 |
| ------------- | ----------------------------------------------- |
| **Type**      | Text field                                      |
| **Default**   | None                                            |
| **Unique?**   | No                                              |
| **Required?** | Yes                                             |
| **Level**     | Enterprise usually, but may be set at any level |
| **Notes**     | See above                                       |

#### *Enable Notification Ringtone*

This setting determines whether a ringtone will play when a push message is received. Which ringtone plays is set by the user in the smartphone **Settings > Sound > Phone ringtone**.

**Entry criteria**

|               |                                                 |
| ------------- | ----------------------------------------------- |
| **Type**      | Radio buttons                                   |
| **Default**   | Disable                                         |
| **Unique?**   | No                                              |
| **Required?** | Default will be used if not otherwise set       |
| **Level**     | Enterprise usually, but may be set at any level |
| **Notes**     | See above                                       |

#### Web API Volume

This setting determines the volume at which the Push Ringtone will play.

**Entry criteria**

|               |                                                 |
| ------------- | ----------------------------------------------- |
| **Type**      | Slider                                          |
| **Default**   | 50                                              |
| **Unique?**   | No                                              |
| **Required?** | No; Default will be used if left unchanged      |
| **Level**     | Enterprise usually, but may be set at any level |
| **Notes**     | See above                                       |

### Telephone Event Notifications

![](https://3032864282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxfLF6IpyutR429bMnvvf%2Fuploads%2Fgit-blob-adea1797994dfb52dbe2a083954fa0686cebe741%2Fimage196.png?alt=media)

The URL to which the smartphone sends notifications of specified events. This offers the ability for the smartphone to send notifications based on various smartphone events such as “Incoming”, “Registration”, etc.

There can be one or more notification events defined, each with a name, URL, and the smartphone events that will cause the event notification to be set. Enter the URL and the Event Label and check the Event type.

{% hint style="info" %}
**Change for Versity R2.1**

The number of events has been reduced from 12 to 8 in the R2.1 release. SAM still supports 12 events for the R1.8 release but the extra 4 will be ignored in R2.1.
{% endhint %}

Use the + (Add) button to repeat for every type of event the App monitors.

{% hint style="info" %}
**Editing event URLs**

If you need to edit an event URL, remove it and re-enter the information with the new URL label or address.
{% endhint %}

#### \[Event URL 1] Label

**Entry criteria**

|               |                                                   |
| ------------- | ------------------------------------------------- |
| **Type**      | Text field                                        |
| **Default**   | None                                              |
| **Unique?**   | No                                                |
| **Required?** | No                                                |
| **Level**     | Enterprise usually, but may be set at any level   |
| **Notes**     | See *Versity* *Applications Administration Guide* |

#### \[Event URL 1] URL

Enter the URL for this Event.

**Entry criteria**

|               |                                                   |
| ------------- | ------------------------------------------------- |
| **Type**      | Text field                                        |
| **Default**   | None                                              |
| **Unique?**   | No                                                |
| **Required?** | No                                                |
| **Level**     | Enterprise usually, but may be set at any level   |
| **Notes**     | See *Versity* *Applications Administration Guide* |

#### Settings

![](https://3032864282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxfLF6IpyutR429bMnvvf%2Fuploads%2Fgit-blob-e0376f9ae439a626ff7dc1867c5e803bb65ddc99%2Fimage197.png?alt=media)

**Entry criteria**

|               |                                                   |
| ------------- | ------------------------------------------------- |
| **Type**      | Check box                                         |
| **Default**   | Off                                               |
| **Unique?**   | No                                                |
| **Required?** | No                                                |
| **Level**     | May be set at any level                           |
| **Notes**     | See *Versity* *Applications Administration Guide* |

## Web Application Shortcuts

![](https://3032864282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxfLF6IpyutR429bMnvvf%2Fuploads%2Fgit-blob-24db35aa9c912df90d8a60c756dcf4d48fc55629%2Fimage198.png?alt=media)

![](https://3032864282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxfLF6IpyutR429bMnvvf%2Fuploads%2Fgit-blob-3ee05e9ad78e3e90817ed5ca61308f0c96ceb03e%2Fimage97.png?alt=media)

Web API allows you to configure the phones to integrate with an XML application. Web applications listed here are Web applications whose shortcuts are displayed in a widget box on one of the home pages of the smartphone. They are opened in the Spectralink Webview browser. Any URL available to the smartphones can be entered. Twelve applications can be configured. Click to add additional shortcuts.

### Label, URL

Enter the Application shortcut label and URL. The label displays in the widget box on the smartphone after the smartphone is rebooted. Note use 6-character abbreviated text for the label as it displays as a label for the icon in the widget box.

**Entry criteria**

|               |                                                 |
| ------------- | ----------------------------------------------- |
| **Type**      | Text fields                                     |
| **Default**   | None                                            |
| **Unique?**   | No                                              |
| **Required?** | No                                              |
| **Level**     | Enterprise usually, but may be set at any level |
| **Notes**     | See above                                       |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.spectralink.net/amie-essentials/applications/web-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.