Top Banner
Videoscape Control Suite 3.5.0 Operator Messaging Service API Guide Overview Introduction This document describes the data model and API of the Cisco Operator Messaging Service (OMS). Document Version This is the second formal release of this document, which was updated for Version 3.5.0 of the Cisco Videoscape Control Suite.
36

Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

Aug 15, 2020

Download

Documents

dariahiddleston
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

Videoscape Control Suite 3.5.0 Operator Messaging Service API Guide

Overview

Introduction

This document describes the data model and API of the Cisco Operator Messaging Service (OMS).

Document Version

This is the second formal release of this document, which was updated for Version 3.5.0 of the Cisco Videoscape Control Suite.

Page 2: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

2 OL-30021-02

In This Document

OMS API Conventions ............................................................................................... 3

Create Message ........................................................................................................... 4

Update Message .......................................................................................................... 6

Delete Message ............................................................................................................ 7

Publish Message .......................................................................................................... 8

Send Message ............................................................................................................ 10

List Groups ................................................................................................................ 12

List Subscribers ......................................................................................................... 13

Add Group ................................................................................................................. 15

Delete Group ............................................................................................................. 17

List Messages ............................................................................................................. 18

Retrieve Messages ..................................................................................................... 20

Get Historical Messages ........................................................................................... 22

Get Historical Message Details ............................................................................... 25

List Rules .................................................................................................................... 27

Add Rule .................................................................................................................... 28

Delete Rule ................................................................................................................. 30

List Rule Parameters ................................................................................................. 31

Add Rule Parameter ................................................................................................. 32

Delete Rule Parameter .............................................................................................. 34

Page 3: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

OL-30021-02 3

OMS API Conventions

OMS API Conventions

Request Headers

The following headers apply in the same manner to all OMS requests.

General HTTP Request Headers

Description

[Content-Type] The content type that the client is prepared to accept in the response.

Default value is application/xml.

Possible Error Codes

The possible error codes returned by this call are:

3001, 3002, 3003, 3004, 3005, 3006, 3007, 3008, 3009

Error Code

Description

3001 Group-related error; for example, the OMS group does not exist, fails to list groups, or fails to retrieve group information.

3002 Subscriber-related error; for example, a failure to list subscribers or retrieve subscriber information.

3003 Message-related error; for example, message does not exist , a failure to retrieve a message, or an invalid message transmission.

3004 Initialization error; for example, a failure to initialize the OMS.

3005 Configuration error; for example, a failure to configure the OMS.

3006 Message publishing error; for example, a failure to publish a message through Pubsub.

3007 UPM-related error; for example, a failure to retrieve user information from the UPM service.

3008 Database-related error; for example, a failure to store group information or historic messages in the database.

3009 Rule-related error; for example, an incorrect rule or rule parameter information.

Page 4: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

4 OL-30021-02

Create Message

Create Message

Request URI

Type: @POST

http://{WebServerIP}:{PORT}/service/{OMSService}?method=create

Message

Request Body

Parameter Type Mandatory Description

arg0 OMS Message

Yes The OMS message

OMS Message

Parameter Type Mandatory Description

fileName String Yes The file name of the message in the FTP server.

message String Yes A URL-encoded string of the OMS message body.

validated Boolean Yes Default is true.

Request Example

curl -l -H "Content-Type:application/xml" --user

restful:conductor -X "POST" --data "

<createMessage><arg0>goqamNewFile</fileName><message>&lt;oms

xmlns='http://conductor.cisco.com/oms/1.0'&gt;&lt;sender&gt;pu

[email protected]&lt;/sender&gt;

&lt;senderName&gt;Luke

Smith&lt;/senderName&gt;&lt;expireTime&gt;2016-12-

17T14:57:00+08:00&lt;

/expireTime&gt;&lt;priority&gt;3&lt;/priority&gt;&lt;type&gt;P

romotion&lt;/type&gt;&lt;scope&gt;Public&lt;

/scope&gt;&lt;title&gt;Title

1&lt;/title&gt;&lt;description&gt;XML encoded

content.&lt;/description&gt;&lt;

Page 5: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

OL-30021-02 5

Create Message

payload&gt;XML encoded

payload.&lt;/payload&gt;&lt;/oms&gt;</message><validated>true<

/validated>

</arg0></createMessage>"209.165.200.3:8100/service/OMSService?

method=createMessage

Response Example: <createMessageResponse></createMessageResponse>

Page 6: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

6 OL-30021-02

Update Message

Update Message

Request URI

Type: @POST

http://{WebServerIP}:{PORT}/service/{OMSService}?method=update

Message

Request Body

Parameter Type Mandatory Description

arg0 String Yes The FileId (file ID) of the OMS message

arg1 OMS Message

Yes The OMS message

Request Example

curl -l -H "Content-Type:application/xml" --user

restful:conductor -X "POST" --data "

<updateMessage><arg0>34912151-3578-46cc-adf9-

b76808d7e943</arg0><arg1>

goqamUpdatedNewFile</fileName><message>&lt;oms

xmlns='http://conductor.cisco.com/oms/1.0'&gt;&lt;

sender&gt;[email protected]&lt;/sender&gt;&lt;senderName

&gt;Luke Smith&lt;/senderName&gt;&lt; expireTime&gt;2016-12-

17T14:57:00+08:00&lt;/expireTime&gt;&lt;priority&gt;3&lt;/prio

rity&gt;

&lt;type&gt;Promotion&lt;/type&gt;&lt;scope&gt;Public&lt;/scop

e&gt;

&lt;title&gt;Title 1&lt;/title&gt;&lt;description&gt;XML

encoded content.&lt;/description&gt;

&lt;payload&gt;XML encoded

payload.&lt;/payload&gt;&lt;/oms&gt;

</message><validated>true</validated></arg1></updateMessage>"

http://209.165.200.3:8100/service/OMSService?method=updateMess

age

Response Example: <updateMessageResponse></updateMessageResponse>

Page 7: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

OL-30021-02 7

Delete Message

Delete Message

Request URI

Type: @POST

http://{WebServerIP}:{PORT}/service/{OMSService}?method=delete

Message

Request Body

Parameter Type Mandatory Description

arg0 String Yes The FileId (file ID) of the OMS message

Request Example

curl -l -H "Content-Type:application/xml" --user

restful:conductor -X "POST" --data

"<deleteMessage><arg0>34912151-3578-46cc-adf9-

b76808d7e943</arg0>

</deleteMessage>"

http://209.165.200.3:8100/service/OMSService?method=deleteMess

age

Page 8: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

8 OL-30021-02

Publish Message

Publish Message

Request URI

Type: @POST

http://{WebServerIP}:{PORT}/service/{OMSService}?method=publis

hMessage

Request Body

Parameter Type Mandatory Description

arg0 String Yes The name of OMS group. The group should have previously been created.

arg1 OMS Message

Yes The data structure of the OMS message.

OMS Message

Parameter Type Mandatory Description

fileName String Yes The file name of the message in the FTP server.

message String Yes A URL-encoded string of the OMS message body.

validated Boolean Yes Default is true.

true: The message has been validated and it is a valid message.

false: It is an invalid message.

Request Example

curl -l -H "Content-Type:application/xml" --user

restful:conductor -X "POST" --data

<publishMessage>

<arg0>groupcd01</arg0>

<arg1>

goqamexample.xml</fileName>

<message>&lt;oms

xmlns='http://conductor.cisco.com/oms/1.0'&gt;

Page 9: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

OL-30021-02 9

Publish Message

&lt;sender&gt;[email protected]&lt;/sender&gt;

&lt;senderName&gt;username1&lt;/senderName&gt;

&lt;expireTime&gt;2012-12-

17T14:57:00+08:00&lt;/expireTime&gt;

&lt;priority&gt;3&lt;/priority&gt;

&lt;type&gt;Promotion&lt;/type&gt;

&lt;scope&gt;Public&lt;/scope&gt;

&lt;title&gt;A title of message&lt;/title&gt;

&lt;description&gt;

XML encoded content.

&lt;/description&gt;

&lt;payload&gt;

XML encoded payload.

&lt;/payload&gt;

&lt;/oms&gt;</message>

<validated>true</validated>

</arg1>

</publishMessage>

http://209.165.200.3:8100/service/OMSService?method=publishMes

sage

Response Example: <publishMessage></publishMessage>

Page 10: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

10 OL-30021-02

Send Message

Send Message

Request URI

Type: @POST

http://{WebServerIP}:{PORT}/service/{OMSService}?method=sendMe

ssage

Request Body

Parameter Type Mandatory Description

arg0 String Yes The user’s ID in the UPM database. The user should already exist in UPM, as well as in the Videoscape Control Suite.

arg1 OMS Message

Yes The data structure of the OMS message.

OMS Message

Parameter Type Mandatory Description

fileName String Yes The file name of the message on the FTP server.

message String Yes A URL-encoded string of the OMS message body.

validated Boolean Yes Default is true.

true: The message has been validated and it is a valid message.

false: It is an invalid message.

Request Example

curl -l -H "Content-Type:application/xml" --user

restful:conductor -X "POST" --data

<sendMessage>

<arg0>groupcd01_user0</arg0>

<arg1>

goqamexample.xml</fileName>

Page 11: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

OL-30021-02 11

Send Message

<message>&lt;oms

xmlns='http://conductor.cisco.com/oms/1.0'&gt;

&lt;sender&gt;[email protected]&lt;/sender&gt;

&lt;senderName&gt;username1&lt;/senderName&gt;

&lt;expireTime&gt;2012-12-

17T14:57:00+08:00&lt;/expireTime&gt;

&lt;priority&gt;3&lt;/priority&gt;

&lt;type&gt;Promotion&lt;/type&gt;

&lt;scope&gt;Public&lt;/scope&gt;

&lt;title&gt;A title of message&lt;/title&gt;

&lt;description&gt;

XML encoded content.

&lt;/description&gt;

&lt;payload&gt;

XML encoded payload.

&lt;/payload&gt;

&lt;/oms&gt;</message>

<validated>true</validated>

</arg1>

</sendMessage>

http://209.165.200.3:8100/service/OMSService?method=sendMessag

e

Response Example <sendMessage></sendMessage>

Page 12: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

12 OL-30021-02

List Groups

List Groups

Request URI

Type: @POST

http://{WebServerIP}:{PORT}/service/{OMSService}?method=listGr

oups

Request Body

None

Request Example curl -l -H "Content-Type:application/xml" --user

restful:conductor -X "POST" --data "<listGroups/>"

http://209.165.200.3:8100/service/OMSService?method=listGroups

Response Example <listGroupsResponse>

<return>

<createTime>2011-11-15T02:37:39+00:00</createTime>

<description></description>

<grpId>1</grpId>

<grpName>restful</grpName>

<grpType>user</grpType>

<rules>cityrule1:city=shanghai</rules>

<status>2</status>

</return>

</listGroupsResponse>

Page 13: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

OL-30021-02 13

List Subscribers

List Subscribers

Request URI

Type: @POST

http://{WebServerIP}:{PORT}/service/{OMSService}?method=listSu

bscribers

Request Body

Parameter Type Mandatory Description

arg0 String Yes The name of the group to list the subscriber

arg1 Int Yes Start index of list, default is 0

arg2 Int Yes End index of list; default is (size-1). For example, the end should be 49 if you want to list the first 50 subscribers.

Request Example

curl -l -H "Content-Type:application/xml" --user

restful:conductor -X "POST" --data

<listSubscribers>

<arg0>restful</arg0>

<arg1>0</arg1>

<arg2>49</arg2>

</listSubscribers>

http://209.165.200.3:8100/service/OMSService?method=listSubscr

ibers

Response Example <listSubscribersResponse>

<return>

<count>1</count>

<result>

<userId>oms_user_username1</userId>

<name>oms_user_username1</name>

<parameters>

Page 14: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

14 OL-30021-02

List Subscribers

<paramName>key1</paramName>

<paramValue>shanghai</paramValue>

</parameters>

<parameters>

<paramName>key2</paramName>

<paramValue>pudong</paramValue>

</parameters>

<parameters>

<paramName>province</paramName>

<paramValue>shanghai</paramValue>

</parameters>

</result>

</return>

</listSubscribersResponse>

Page 15: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

OL-30021-02 15

Add Group

Add Group

Request URI

Type: @POST

http://{WebServerIP}:{PORT}/service/{OMSService}?method=addGro

up

Request Body

Parameter Type Mandatory Description

arg0 OMS group Yes The data structure of the group.

OMS Group

Parameter Type Mandatory Description

grpId String Yes Default is empty; assigned by backend.

grpType String Yes Default is ‘user’.

createTime String Yes Default is 0; generated by back end.

grpName String Yes Default source is GUI.

rules String Yes The rule of this group. Format is <rule name>:<rule

key>=<rule value>.

A rule can contain multiple key/value pairs, which are separated by a semicolon.

description String No The description of this group.

status String Yes The status of this group:

0 — normal

1 — sync with UPM service

2 — error

Page 16: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

16 OL-30021-02

Add Group

Request Example

curl -l -H "Content-Type:application/xml" --user

restful:conductor -X "POST" --data

<addGroup>

<arg0>

<grpId></grpId>

<grpType>user</grpType>

<createTime>0</createTime>

<grpName>restful</grpName>

<rules>cityrule1:city=shanghai</rules>

<description></description>

<status>0</status>

</arg0>

</addGroup>

http://209.165.200.3:8100/service/OMSService?method=addGroup

Request Response <addGroupResponse></addGroupResponse>

Page 17: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

OL-30021-02 17

Delete Group

Delete Group

Request URI

Type: @POST

http://{WebServerIP}:{PORT}/service/{OMSService}?method=delete

Group

Request Body

Parameter Type Mandatory Description

arg0 String Yes The name of the group to delete.

Request Example

curl -l -H "Content-Type:application/xml" --user

restful:conductor -X "POST" --data

<deleteGroup>

<arg0>restful</arg0>

</deleteGroup>

http://209.165.200.3:8100/service/OMSService?method=deleteGrou

p

Response Example <deleteGroupResponse></deleteGroupResponse>

Page 18: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

18 OL-30021-02

List Messages

List Messages

Request URI

Type: @POST

http://{WebServerIP}:{PORT}/service/{OMSService}?method=listMe

ssages

Request Body

none

Request Example curl -l -H "Content-Type:application/xml" --user

restful:conductor -X "POST" --data "<listMessages/>"

http://209.165.200.3:8100/service/OMSService?method=listMessag

es

Response Example <listMessagesResponse>

<return>

goqamtest_sender_1.xml</filename>

<lastModTime>2012-10-23T16:00:00+00:00</lastModTime>

<size>1464</size>

<user>0</user>

</return>

<return>

goqamtest_sender_2.xml</filename>

<lastModTime>2012-10-23T16:00:00+00:00</lastModTime>

<size>1465</size>

<user>0</user>

</return>

<return>

goqamtest_sender_3.xml</filename>

<lastModTime>2012-10-23T16:00:00+00:00</lastModTime>

<size>434</size>

<user>0</user>

</return>

Page 19: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

OL-30021-02 19

List Messages

<return>

goqamtest_sender_4.xml</filename>

<lastModTime>2012-10-23T16:00:00+00:00</lastModTime>

<size>421</size>

<user>0</user>

</return>

<return>

goqamtest_sender_5.xml</filename>

<lastModTime>2012-10-23T16:00:00+00:00</lastModTime>

<size>503</size>

<user>0</user>

</return>

<return>

</listMessagesResponse>

Page 20: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

20 OL-30021-02

Retrieve Messages

Retrieve Messages

Request URI

Type: @POST

http://{WebServerIP}:{PORT}/service/{OMSService}?method=retrie

veMessages

Request Body

Parameter Type Mandatory Description

arg0 String Yes The file name to be retrieved.

Request Example

curl -l -H "Content-Type:application/xml" --user

restful:conductor -X "POST" --data

<retrieveMessages>

<arg0>test_sender_1.xml</arg0>

</retrieveMessages>

http://209.165.200.3:8100/service/OMSService?method=retrieveMe

ssages

Response Example <retrieveMessagesResponse>

<return>

goqamtest_sender_1.xml</fileName>

<message>&lt;?xml version='1.0' encoding='utf-8'?&gt;

&lt;oms

xmlns="http://conductor.cisco.com/oms/1.0"&gt;

&lt;sender&gt;ssssssss&lt;/sender&gt;

&lt;senderName&gt;username1&lt;/senderName&gt;

&lt;expireTime&gt;2012-12-

17T14:57:00+08:00&lt;/expireTime&gt;

&lt;priority&gt;3&lt;/priority&gt;

&lt;type&gt;Promotion&lt;/type&gt;

&lt;scope&gt;Test&lt;/scope&gt;

&lt;title&gt;A title of message&lt;/title&gt;

&lt;description&gt;

Page 21: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

OL-30021-02 21

Retrieve Messages

Content.

&lt;/description&gt;

&lt;payload&gt;

Payload.

&lt;/payload&gt;

&lt;/oms&gt;</message>

<validated>true</validated>

</return>

</retrieveMessagesResponse>

Page 22: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

22 OL-30021-02

Get Historical Messages

Get Historical Messages

Request URI

Type: @POST

http://{WebServerIP}:{PORT}/service/{OMSService}?method=getHis

toricMessages

Request Body

Parameter Type Mandatory Description

arg0 Type Yes Search type; default type is range.

arg1 Search keyword Yes Search keyword. For range search, the keyword could be one of ‘from’ or ‘to’.

arg2 Search value Yes Search value corresponding to search keyword.

arg3 Search keyword Yes Search keyword. For range search, the keyword could be one of ‘from’ or ‘to’.

arg4 Search value Yes Search value corresponding to search keyword.

Request Example

curl -l -H "Content-Type:application/xml" --user

restful:conductor -X "POST" --data

<getHistoricMessages>

<arg0>

<type>range</type>

<key>from</key>

<value>0</value>

</arg0>

<arg0>

<type>range</type>

Page 23: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

OL-30021-02 23

Get Historical Messages

<key>to</key>

<value>2</value>

</arg0>

</getHistoricMessages>

http://209.165.200.3:8100/service/OMSService?method=getHistori

cMessages

Response Example <getHistoricMessagesResponse>

<return>

<count>33</count>

<queryCriteria>

<key>from</key>

<type>range</type>

<value>0</value>

</queryCriteria>

<queryCriteria>

<key>to</key>

<type>range</type>

<value>2</value>

</queryCriteria>

<results>

<expireTime>2012-12-17T14:57:00+08:00</expireTime>

<failReason></failReason>

goqamchinese_msg2.xml</fileName>

<msgId>3319</msgId>

<msgType>1</msgType>

<prority>3</prority>

<receiver>group_chinese</receiver>

<scope>Public</scope>

<sendResult>0</sendResult>

<sendTime>2012-07-27T02:41:45+00:00</sendTime>

<sender>[email protected]</sender>

<senderName>username1</senderName>

<title>Intern</title>

<type>Promotion</type>

</results>

Page 24: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

24 OL-30021-02

Get Historical Messages

<results>

<expireTime>2012-12-17T14:57:00+08:00</expireTime>

<failReason></failReason>

goqamchinese_msg2.xml</fileName>

<msgId>3318</msgId>

<msgType>1</msgType>

<prority>3</prority>

<receiver>group_chinese</receiver>

<scope>Public</scope>

<sendResult>0</sendResult>

<sendTime>2012-07-27T02:37:16+00:00</sendTime>

<sender>[email protected]</sender>

<senderName>username1</senderName>

<title>Intern</title>

<type>Promotion</type>

</results>

</return>

</getHistoricMessagesResponse>

Page 25: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

OL-30021-02 25

Get Historical Message Details

Get Historical Message Details

Request URI

Type: @POST

http://{WebServerIP}:{PORT}/service/{OMSService}?method=getHis

toricMessageDetail

Request Body

Parameter Type Mandatory Description

arg0 long Yes The unique message ID of a specific message.

Request Example

curl -l -H "Content-Type:application/xml" --user

restful:conductor -X "POST" --data

<getHistoricMessageDetail>

<arg0>3319</arg0>

</getHistoricMessageDetail>

http://209.165.200.3:8100/service/OMSService?method=getHistori

cMessageDetail

Response Example <getHistoricMessageDetailResponse>

<return>

<description>Intern,Intern,Intern,Intern,Intern,Intern,</descr

iption>

<expireTime>2012-12-17T14:57:00+08:00</expireTime>

<failReason></failReason>

goqamchinese_msg2.xml</fileName>

<msgId>3319</msgId>

<msgType>1</msgType>

<payload>this is the payload</payload>

<prority>3</prority>

<receiver>group_chinese</receiver>

<scope>Public</scope>

Page 26: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

26 OL-30021-02

Get Historical Message Details

<sendResult>0</sendResult>

<sendTime>2012-07-27T02:41:45+00:00</sendTime>

<sender>[email protected]</sender>

<senderName>username1</senderName>

<title>Intern</title>

<type>Promotion</type>

</return>

</getHistoricMessageDetailResponse>

Page 27: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

OL-30021-02 27

List Rules

List Rules

Request URI

Type: @POST

http://{WebServerIP}:{PORT}/service/{OMSService}?method=listRu

les

Request Body

None

Request Example curl -l -H "Content-Type:application/xml" --user

restful:conductor -X "POST" --data "<listRules/>"

http://209.165.200.3:8100/service/OMSService?method=listRules

Response Example <listRulesResponse>

<return>

<description></description>

<operator>EqualTo</operator>

<parameter>city</parameter>

<ruleName>cityrule1</ruleName>

<type>List</type>

<value>shanghai</value>

</return>

</listRulesResponse>

Page 28: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

28 OL-30021-02

Add Rule

Add Rule

Request URI

Type: @POST

http://{WebServerIP}:{PORT}/service/{OMSService}?method=addRul

e

Request Body

Parameter Type Mandatory Description

arg0 Rule Yes The data structure of the rule.

Rule

Parameter Type Mandatory Description

ruleName String Yes The name of the rule.

description String No The description of the rule parameter.

type String Yes The possible types of rule parameters are:

String

List

parameter String Yes The name of the rule parameter used by this rule.

operator String Yes The default operator is ‘EqualTo’.

value String Yes The value of the rule parameter used by this rule.

Request Example

curl -l -H "Content-Type:application/xml" --user

restful:conductor -X "POST" --data

<addRule>

<arg0>

<ruleName>cityrule1</ruleName>

<description></description>

<type>List</type>

Page 29: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

OL-30021-02 29

Add Rule

<parameter>city</parameter>

<operator>EqualTo</operator>

<value>shanghai</value>

</arg0>

</addRule>

Response Example <addRuleResponse></addRuleResponse>

Page 30: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

30 OL-30021-02

Delete Rule

Delete Rule

Request URI

Type: @POST

http://{WebServerIP}:{PORT}/service/{OMSService}?method=delete

Rule

Request Body

Parameter Type Mandatory Description

arg0 String Yes The name of the rule to delete.

Request Example

curl -l -H "Content-Type:application/xml" --user

restful:conductor -X "POST" --data

<deleteRule>

<arg0>cityrule1</arg0>

</deleteRule>

http://209.165.200.3:8100/service/OMSService?method=deleteRule

Response Example <deleteRuleResponse></deleteRuleResponse>

Page 31: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

OL-30021-02 31

List Rule Parameters

List Rule Parameters

Request URI

Type: @POST

http://{WebServerIP}:{PORT}/service/{OMSService}?method=listRu

leParameters

Request Body

None

Request Example curl -l -H "Content-Type:application/xml" --user

restful:conductor -X "POST" --data "<listRuleParameters/>"

http://209.165.200.3:8100/service/OMSService?method=listRulePa

rameters

Response Example <listRuleParametersResponse>

<return>

<description></description>

<ruleParameterName>city</ruleParameterName>

<seqNum>3</seqNum>

<source>GUI</source>

<type>List</type>

<value>shanghai;beijing</value>

</return>

</listRuleParametersResponse>

Page 32: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

32 OL-30021-02

Add Rule Parameter

Add Rule Parameter

Request URI

Type: @POST

http://{WebServerIP}:{PORT}/service/{OMSService}?method=addRul

eParameter

Request Body

Parameter Type Mandatory Description

arg0 RuleParameter Yes The data structure of the rule parameter.

Rule Parameter

Parameter Type Mandatory Description

ruleParameterName String Yes The name of the rule parameter.

type String Yes The possible types of rule parameters are:

String

List

value String Yes The value of the rule parameter is String. If there are multiple strings, the separator is ‘;’.

source String Yes Default source is ‘GUI’.

description String No The description of rule parameter.

Request Example

curl -l -H "Content-Type:application/xml" --user

restful:conductor -X "POST" --data

<addRuleParameter>

<arg0>

<ruleParameterName>city</ruleParameterName>

<type>List</type>

<value>shanghai;beijing</value>

Page 33: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

OL-30021-02 33

Add Rule Parameter

<source>GUI</source>

<description></description>

</arg0>

</addRuleParameter>

http://209.165.200.3:8100/service/OMSService?method=addRulePar

ameter

Response Example <addRuleParameterResponse></addRuleParameterResponse>

Page 34: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

34 OL-30021-02

Delete Rule Parameter

Delete Rule Parameter

Request URI

Type: @POST

http://{WebServerIP}:{PORT}/service/{OMSService}?method=delete

RuleParameter

Request Body

Parameter Type Mandatory Description

arg0 String Yes The name of the rule parameter to delete.

Request Example

curl -l -H "Content-Type:application/xml" --user

restful:conductor -X "POST" --data

<deleteRuleParameter>

<arg0>city</arg0>

</deleteRuleParameter>

http://209.165.200.3:8100/service/OMSService?method=deleteRule

Parameter

Response Example <deleteRuleParameterResponse></deleteRuleParameterResponse>

Page 35: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter
Page 36: Videoscape Control Suite 3.5.0 Operator Messaging Service ...€¦ · as in the Videoscape Control Suite. arg1 OMS Message Yes The data structure of the OMS message. OMS Message Parameter

For Information

If You Have Questions

If you have technical questions, contact Cisco Services for assistance. Follow the menu options to speak with a service engineer.

Americas Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA

http://www.cisco.com Tel: 408 526-4000

800 553-6387 Fax: 408 527-0883

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R) Product and service availability are subject to change without notice.

© 2014 Cisco and/or its affiliates. All rights reserved. June 2014 Part Number OL-30021-02