SendCustomNoticeToAgents
This operation is part of the SMS Session API section of the Web Services API.
Overview
This request sends a custom notice only to agents who are in a conference or consultation.
Request URL | /api/v2/me/smssessions/{id} |
---|---|
HTTP Method | POST |
Required Features | api-multimedia |
Parameters
Parameter | Value |
---|---|
operationName | SendCustomNoticeToAgents |
noticeText | The notice text to send to agents in a conference or consultation. |
Sample
Request
POST api/v2/me/chats/0000RaB4Q006001K
POST api/v2/me/smssessions/0000RaB4Q006001K
{
"operationName": "SendCustomNoticeToAgents",
"noticeText": "This is a custom notice to Agents"
}
Response
{
"statusCode": 0
}
Notification
Notification received after send custom notice to agents.
{
"smssessionPath": "/smssessions/0000RaB4Q006001K",
"messages": [
{
"index": 5,
"noticeText": "This is a custom notice to Agents",
"from": {
"participantId": "0093564DAC510041",
"type": "Agent",
"uri": "http://localhost:8090/api/v2/users/4ff5b43c856d4cb2a3d6c20a88740257",
"visibility": "All",
"path": "/users/4ff5b43c856d4cb2a3d6c20a88740257",
"nickname": "TestName",
"id": "0093564DAC510041"
},
"timestamp": "2015-11-19 13:02:43.000+0200",
"visibility": "Agents",
"type": "CustomNotice",
"timestampSeconds": 1447930963000L
}
],
"notificationType": "NewMessages",
"messageType": "MessageLogUpdated",
"smssessionUri": "http://localhost:8090/api/v2/smssessions/0000RaB4Q006001K"
}
This page was last edited on November 4, 2016, at 17:54.
Comments or questions about this documentation? Contact us for support!