REST Reference
URI
The REST URI for Jabber Guest is:
/cjg-api/rest/links
For example if a Jabber Guest service is set up at a hostname jabberguest.example.com
, we would be making our requests to:
https://jabberguest.example.com/cjg-api/rest/links
HTTP Methods
HTTP Method | Action |
---|---|
POST | Create a link |
DELETE | Delete a link |
Call Link JSON Attributes
When using the Call Link REST API, these are the relevant JSON attributes to consider.
Name | Type | Required | Description |
---|---|---|---|
destination |
String |
Y | Directory number, or URI (if URI dialing has been enabled) of the recipient who the web end-user will be calling) |
isEnabled |
Boolean |
Y | Whether this call link should be usable or not (still subject to validBefore and validAfter though) |
callerName |
String |
N | The name displayed to the recipient of the call, of who is calling them |
displayName |
String |
N | The name displayed to the web end-user of whom they will be calling |
requestPath |
String |
N | The tail-end of a call link URL (ex. http://www.example.com/call/<requestPath> ) |
validAfter |
String |
N | Datetime of the earliest moment in which the call link is valid (format: "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" ) |
validBefore |
String |
N | Datetime of when the call link should expire (format: "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" ) |
autoCallAfterSecs |
Integer |
N | Timer in seconds to automatically start a guest call. The value range is [-1, 60] as integer. Default value is -1 which means not to start a call automatically. Value 0 means start a immediate call automatically. |
videoPolicy |
String |
N | Guest video policy which can be set as four options: |