Messages API

Conversation Common Object

OVERVIEW

 An object representing message

 

     <conversation>
        <conversationid>{conversation id}</conversationid>
        <recipients>
            <users>
                <user>
                    <userid>{User id}</userid>
                    <name>
                         <firstname>{first name}</firstname>
                         <lastname>{last name}</lastname>
                    </name>
                    <httpavatar>{get author's avatar - http call}</httpavatar>
                    <avatar>{get author's avatar - API call}</avatar>
                    <userlink>{author's detail - API}</userlink>
                    <httplink>{{author's detail - http}}</httplink>
                </user>
                 <user>
                    <userid>{User id}</userid>
                    <name>
                          <firstname>{first name}</firstname>
                          <lastname>{last name}</lastname>
                    </name>
                    <httpavatar>{get author's avatar - http call}</httpavatar>
                    <avatar>{get author's avatar - API call}</avatar>
                    <userlink>{author's detail - API}</userlink>
                    <httplink>{{author's detail - http}}</httplink>
                </user>
            </users>
        </recipients>
        <messages>
            <message>
                <messageid>{message id}</messageid>
                <recipients>
                    <users>
                        <user>
                            <userid>{User id}</userid>
                            <name>
                                 <firstname>{first name}</firstname>
                                 <lastname>{last name}</lastname>
                            </name>
                            <httpavatar>{get author's avatar - http call}</httpavatar>
                            <avatar>{get author's avatar - API call}</avatar>
                            <userlink>{author's detail - API}</userlink>
                            <httplink>{{author's detail - http}}</httplink>
                        </user>
                         <user>
                            <userid>{User id}</userid>
                            <name>
                                 <firstname>{first name}</firstname>
                                 <lastname>{last name}</lastname>
                            </name>
                            <httpavatar>{get author's avatar - http call}</httpavatar>
                            <avatar>{get author's avatar - API call}</avatar>
                            <userlink>{author's detail - API}</userlink>
                            <httplink>{{author's detail - http}}</httplink>
                        </user>
                    </users>
                </recipients>
                <text>{message snippet - without formatting}</text>
                <html><![CDATA[<p>{actual content - with formatting}</p>]]> </html>
                <lastsentdatetime></lastsentdatetime>
                <images>
                    <image>
                        <imagelink>{image link - http}</imagelink>
                        <apilink>{API link to image file's thumbnail}</apilink>
                    </image>
                </images>
                <attachments>
                    <attachment>
                        <id>{attachment/file - id}</id>
                        <name>{attachment/file - name}</name>
                        <extension>{attachment/file - extension}</extension>
                        <siteid>{attachment/file - site id}</siteid>
                        <parentfolderid>{attachment/file - parent folder id}</parentfolderid>
                        <filesize>1587</filesize>
                    </attachment>
                    <attachment>
                        <id>{attachment/file - id}</id>
                        <name>{attachment/file - name}</name>
                        <extension>{attachment/file - extension}</extension>
                        <siteid>{attachment/file - site id}</siteid>
                        <parentfolderid>{attachment/file - parent folder id}</parentfolderid>
                        <filesize>1587</filesize>
                    </attachment>
                </attachments>
            </message>
        </messages>
    </conversation>

Comments


0 Comments

Last Updated: Jun 09,2023