Jump to: navigation, search

SendCustomNotice

This operation is part of the SMS Session API section of the Web Services API.

Overview

This request sends a custom notice to all SMS session participants.

Request URL /api/v2/me/smsessions/{id}
HTTP Method POST
Required Features api-multimedia

Parameters

Parameter Value
operationName SendCustomNotice
noticeText The notice text to send to all SMS session participants.

Sample

Request

POST api/v2/me/smsessions/0000RaB4Q006001F
{
  "operationName": "SendCustomNotice",
  "noticeText": "This is a custom notice"
}

Response

{
  "statusCode": 0
}

Notification

{
    "smsessionPath": "/smsessions/0000RaB4Q006001F",
    "messages": [
        {
            "index": 5,
            "noticeText": "This is a custom notice",
            "from": {
                "participantId": "0093564DA4BB0039",
                "type": "Agent",
                "uri": "http://localhost:8090/api/v2/users/4ff5b43c856d4cb2a3d6c20a88740257",
                "visibility": "All",
                "path": "/users/4ff5b43c856d4cb2a3d6c20a88740257",
                "nickname": "TestName",
                "id": "0093564DA4BB0039"
            },
            "timestamp": "2015-11-19 12:30:20.000+0200",
            "visibility": "All",
            "type": "CustomNotice",
            "timestampSeconds": 1447929020000L
        }
    ],
    "notificationType": "NewMessages",
    "messageType": "MessageLogUpdated",
    "smsessionUri": "http://localhost:8090/api/v2/smsessions/0000RaB4Q006001F"
}

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on November 4, 2016, at 09:53.