{"type":"doc","content":[{"type":"paragraph","content":[{"text":"NeedsExamples","type":"text","marks":[{"type":"code"}]}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"outline":{"value":"true"},"indent":{"value":"20px"},"style":{"value":"none"},"printable":{"value":"false"}},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}},{"type":"paragraph","content":[{"text":"osapi.messages","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Service object with functions that map to the ","type":"text"},{"text":".-RPC-Protocol.xml#Messages JSON-RPC Messages endpoint","type":"text","marks":[{"type":"link","attrs":{"href":"https://opensocial.atlassian.net/wiki/pages/createpage.action?spaceKey=a&title=.-RPC-Protocol.xml"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Methods","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"osapi.messages.send","type":"text"}]},{"type":"paragraph","content":[{"text":"; ","type":"text"},{"text":"osapi.Request","type":"text","marks":[{"type":"link","attrs":{"href":"https://opensocial.atlassian.net/wiki/spaces/OSD/pages/526922"}}]},{"text":" osapi.messages.send(params)","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"\nNameTypeDescription | ","type":"text"}]},{"type":"panel","attrs":{"panelType":"custom"},"content":[{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"nestedContent":{"type":"doc","content":[{"type":"table","attrs":{"layout":"align-start"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" params ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" {AuthToken auth = HttpRequest.Authorization,String userId = \"@me\",opensocial.Message message} ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" An optional JSON object containing request parameters. See the send operation of the ","type":"text"},{"text":".-RPC-Protocol.xml#Messages JSON-RPC Messages service","type":"text","marks":[{"type":"link","attrs":{"href":"https://opensocial.atlassian.net/wiki/pages/createpage.action?spaceKey=a&title=.-RPC-Protocol.xml"}}]},{"text":" for more details. ","type":"text"}]}]}]}]}],"version":1},"cxhtml":"\n\n\n\n\n\n

params

{AuthToken auth = HttpRequest.Authorization,String userId = "@me",opensocial.Message message}

An optional JSON object containing request parameters. See the send operation of the for more details.

"}}}]},{"type":"paragraph","content":[{"text":"Returns","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"\nTypeDescription | ","type":"text"}]},{"type":"panel","attrs":{"panelType":"custom"},"content":[{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"nestedContent":{"type":"doc","content":[{"type":"table","attrs":{"layout":"align-start"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"},{"text":"osapi.Request","type":"text","marks":[{"type":"link","attrs":{"href":"https://opensocial.atlassian.net/wiki/spaces/OSD/pages/526922"}}]},{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" A request to retrieve information from the ","type":"text"},{"text":".-RPC-Protocol.xml#Messages JSON-RPC Messages service","type":"text","marks":[{"type":"link","attrs":{"href":"https://opensocial.atlassian.net/wiki/pages/createpage.action?spaceKey=a&title=.-RPC-Protocol.xml"}}]},{"text":". ","type":"text"}]}]}]}]}],"version":1},"cxhtml":"\n\n\n\n\n

osapi.Request

A request to retrieve information from the .

"}}}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"\nBuilds a request to send a message from the Messages JSON-RPC service.","type":"text"}]},{"type":"paragraph","content":[{"text":"{{ JsApiAlphaList_(v0.9) }}","type":"text"}]}],"version":1}

Osapi.messages (v0.9)

Methods

osapi.messages.send