| Status |
|---|
| subtle | true |
|---|
| colour | Yellow |
|---|
| title | AVAILABLE FROM VERSION 2.5.0 |
|---|
|
You can send a notification to an agent or a group of agents authenticated on the web interface by using the following API endpoint:
| Code Block |
|---|
|
POST /api/notifications |
PARAMETERS
...
...
TemplateId
view
...
recipients
recipientsDescription
beep
...
| The content of the notification |
| TemplateId | Id of the template used as the notification's content |
| view | View object used to render the selected template |
| senderName | The name of the sender (optional). Default: the name of the user sending the notification. |
| recipients | Array of recipients as string (see details) |
| recipientsDescription | Description of recipients |
...
| that will be displayed in the notification title (optional) |
| beep | Enable/Disable audio notification. Default: false |
| Info |
|---|
|
The recipients array must contains at least one object structured as below:| Code Block |
|---|
{
"model": "user",
"ids": [1, 2]
} |
- model: identifies the entity group to which the notification will be sent
- ids: a list of the selected model's resources' ids
The following models are supported: - chatqueue
- faxqueue
- mailqueue
- openchannelqueue
- smsqueue
- voicequeue
- whatsappqueue
- team
- user
| Note |
|---|
If you specify as a model a queue or team that does not have any agents associated, no notification will be sent. |
|
EXAMPLES
...
Sending a simple text notification
Image Added
| Code Block |
|---|
| language | xml |
|---|
| theme | Confluence |
|---|
|
POST https://{host}/api/notifications
{
"text": "Hello!",
"recipients": "[{\"model\": \"user\", \"ids\": [1]}]",
"recipientsDescription": "This is a description",
"beep": false
} |
| Code Block |
|---|
| language | xml |
|---|
| theme | FadeToGreyMidnight |
|---|
|
curl httpshttp://{host}/api/notifications -d '[{"text": "Hello!", "recipients": "[{\"model\": \"user\", \"ids\": [1]}]", "recipientsDescription": "This is a description", "beep": "false"}]' -v -u {name}:{password} -X POSTH "Content-Type: application/json" |
Using a template
Image Added
| Code Block |
|---|
| language | xml |
|---|
| theme | Confluence |
|---|
|
POST https://{host}/api/notifications
{
"TemplateId": 1,
"view": {"content": "Hello!"},
"recipients": "[{\"model\": \"userteam\", \"ids\": [1]}, {\"model\": \"voiceQueue\", \"ids\": [2,3]}]",
"recipientsDescription": "ThisGroup isof a descriptionagents",
"beep": true
} |
| Code Block |
|---|
| language | xml |
|---|
| theme | FadeToGreyMidnight |
|---|
|
curl https://{host}/api/notifications -d '[{"TemplateId": "1", "view": {"textcontent": "Hello!"}, "recipients": "[{\"model\": \"userteam\", \"ids\": [1]}, {\"model\": \"voiceQueue\", \"ids\": [2,3]}]", "recipientsDescription": "ThisGroup isof a descriptionagents", "beep": "falsetrue"}]' -v -u {name}:{password} -H "Content-X POSTType: application/json" |