RHP_API

CreateNotificationMessage

The following routes are available for this service:
POST	/User/Notification/Message

**CreateNotificationMessage** Parameters:
Name	Parameter	Data Type	Required
Receiver	body	long	No
Message	body	string	No
NotificationType	body	NotificationMessageType	No
ConversationKey	body	string	No
OriginalMessageID	body	int	No
MediaID	body	int	No
MediaType	body	MediaType	No
MessageDetail	body	Detail	No

**Detail** Parameters:
Name	Parameter	Data Type	Required
FromJid	form	string	No
ToJid	form	string	No
MsgId	form	string	No
MsgType	form	string	No
Data	form	MsgBody	No
Time	form	long	No
ChatType	form	string	No
ConvId	form	int	No

**MsgBody** Parameters:
Name	Parameter	Data Type	Required
Text	form	string	No
Image	form	Image	No
VideoFile	form	VideoFile	No
Gallery	form	Gallery	No
Gift	form	Gift	No
Gif	form	Gif	No
Video	form	Video	No
Reactions	form	Reaction	No
ShareLocation	form	ShareLocation	No
ShareDate	form	ShareDate	No
ShareEvent	form	ShareEvent	No
ShareEventTicket	form	ShareEvent	No
QuotedMessage	form	QuotedMessage	No
Expts	form	long	No
IsRecvMatching	form	bool	No
IsSenderMatching	form	bool	No
SenderMemberLevel	form	int	No
RecvMemberLevel	form	int	No
InviteGroupChat	form	InviteGroupChat	No
JoinGroupChat	form	JoinGroupChat	No
LeaveGroupChat	form	LeaveGroupChat	No
RemovedFromGroup	form	RemovedFromGroup	No
ProfilePhotoComment	form	ProfilePhotoComment	No
InviteGroup	form	InviteGroup	No

**Image** Parameters:
Name	Parameter	Data Type	Required
PhotoId	form	int	No
ThumbUrl	form	string	No
FullUrl	form	string	No

**VideoFile** Parameters:
Name	Parameter	Data Type	Required
VideoId	form	int	No
ThumbUrl	form	string	No
Duration	form	int	No
OwnerUserId	form	long	No

**Gallery** Parameters:
Name	Parameter	Data Type	Required
GalleryId	form	int	No
ImageCount	form	int	No
Name	form	string	No
friendId	form	long	No
hasRestricted	form	bool	No
isGranted	form	bool	No
isPublic	form	bool	No

**Gift** Parameters:
Name	Parameter	Data Type	Required
GiftId	form	int	No
Name	form	string	No
Description	form	string	No
Diamonds	form	int	No
Level	form	int	No
Price	form	int	No
Data	form	string	No
ImageUrl	form	string	No

**Gif** Parameters:
Name	Parameter	Data Type	Required	Description
FixedWidth	form	string	No
Original	form	string	No

**Video** Parameters:
Name	Parameter	Data Type	Required	Description
RequestType	form	string	No
Value	form	string	No

**Reaction** Parameters:
Name	Parameter	Data Type	Required
ToMsgId	form	string	No
Unicode	form	string	No
Clear	form	bool	No

**ShareLocation** Parameters:
Name	Parameter	Data Type	Required	Description
Latitude	form	double	No
Longitude	form	double	No

**ShareDate** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No

**ShareEvent** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No

**QuotedMessage** Parameters:
Name	Parameter	Data Type	Required
RefMsgId	form	string	No
RefUserId	form	long	No
RefMsgType	form	string	No
RefMsgShortDesc	form	string	No
RefDisplayName	form	string	No
RefMsgExpTs	form	long	No
RefMsgTitle	form	string	No

**InviteGroupChat** Parameters:
Name	Parameter	Data Type	Required	Description
RoomJID	form	string	No
Value	form	string	No

**JoinGroupChat** Parameters:
Name	Parameter	Data Type	Required	Description
UserId	form	long	No
Value	form	string	No

**LeaveGroupChat** Parameters:
Name	Parameter	Data Type	Required	Description
UserId	form	long	No
Value	form	string	No

**RemovedFromGroup** Parameters:
Name	Parameter	Data Type	Required	Description
UserId	form	long	No
Value	form	string	No

**ProfilePhotoComment** Parameters:
Name	Parameter	Data Type	Required
UserID	form	long	No
PhotoID	form	string	No
ThumbURL	form	string	No
FullURL	form	string	No

**InviteGroup** Parameters:
Name	Parameter	Data Type	Required	Description
GroupID	form	int	No
Value	form	string	No

**CreateMessageResponse** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
ErrorCode	form	string	No
ErrorMsg	form	string	No
Authorisation	form	UserNotificationMessageAuthorisation	No

**UserNotificationMessageAuthorisation** Parameters:
Name	Parameter	Data Type	Required	Description
Reason	form	UserNotificationReason	No	The descriptor for CanSend, used to provide additional information to the client.
CanSend	form	bool	No	If true the current user can send.
Remaining	form	int	No	Number of conversations remaining for the Sender.
RemainingCredits	form	int	No	Number of conversations credit remaining for the Sender.
Detail	form	string	No	Detail of permissions. DEBUG ONLY
CanVideoCall	form	bool	No	If true the Sender can use Video with the Receiver
CanSendPhotos	form	bool	No	If true the Sender can send Photos to the Receiver
CanSendGifts	form	bool	No	If true the Sender can send Gifts to the Receiver
SenderIsDiamond	form	bool	No	If true the Sender is a Diamond Club member
ReceiverIsDiamond	form	bool	No	If true the Sender is a Diamond Club member
SenderProfileMatching	form	bool	No	Is the Sender a profile match with the Receiver. If true, the message should display in the Sender's Matching filter.
ReceiverProfileMatching	form	bool	No	Is the Receiver a profile match with the Sender. If true, the message should display in the Receiver's Matching filter.
ReceiverMemberLevel	form	LookupValueBase	No	The Memberlevel of the Receiver
SenderMemberLevel	form	LookupValueBase	No	The Memberlevel of the Sender
TimeToReset	form	double	No	Time remaining until reset.
ConversationKey	form	string	No	Unique key for a user's conversation.
DefEn	form	string	No	For Debug purpose only.
UpgradeAction	form	MessageUpgradeType	No	If a user can not send a message, this is the upgrade path.
IsCreditSend	form	bool	No	If true the user will be charged a credit.
MessageBanExpiry	form	DateTime?	No
SendPhotosBanExpiry	form	DateTime?	No
TimeStamp	form	DateTime	No

**LookupValueBase** Parameters:
Name	Parameter	Data Type	Required
Value	form	int	No
Text	form	string	No
TextAbbr	form	string	No
ListID	form	int?	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /User/Notification/Message HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateNotificationMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <ConversationKey>String</ConversationKey>
  <MediaID>0</MediaID>
  <MediaType>Undefined</MediaType>
  <Message>String</Message>
  <MessageDetail xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP.External.Nexle.XMPP.Model.NotificationMessage">
    <d2p1:ChatType>String</d2p1:ChatType>
    <d2p1:ConvId>0</d2p1:ConvId>
    <d2p1:Data>
      <d2p1:Expts>0</d2p1:Expts>
      <d2p1:Gallery>
        <d2p1:GalleryId>0</d2p1:GalleryId>
        <d2p1:ImageCount>0</d2p1:ImageCount>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:friendId>0</d2p1:friendId>
        <d2p1:hasRestricted>false</d2p1:hasRestricted>
        <d2p1:isGranted>false</d2p1:isGranted>
        <d2p1:isPublic>false</d2p1:isPublic>
      </d2p1:Gallery>
      <d2p1:Gif>
        <d2p1:FixedWidth>String</d2p1:FixedWidth>
        <d2p1:Original>String</d2p1:Original>
      </d2p1:Gif>
      <d2p1:Gift>
        <d2p1:Data>String</d2p1:Data>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:Diamonds>0</d2p1:Diamonds>
        <d2p1:GiftId>0</d2p1:GiftId>
        <d2p1:ImageUrl>String</d2p1:ImageUrl>
        <d2p1:Level>0</d2p1:Level>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:Price>0</d2p1:Price>
      </d2p1:Gift>
      <d2p1:Image>
        <d2p1:FullUrl>String</d2p1:FullUrl>
        <d2p1:PhotoId>0</d2p1:PhotoId>
        <d2p1:ThumbUrl>String</d2p1:ThumbUrl>
      </d2p1:Image>
      <d2p1:InviteGroup>
        <d2p1:GroupID>0</d2p1:GroupID>
        <d2p1:Value>String</d2p1:Value>
      </d2p1:InviteGroup>
      <d2p1:InviteGroupChat>
        <d2p1:RoomJID>String</d2p1:RoomJID>
        <d2p1:Value>String</d2p1:Value>
      </d2p1:InviteGroupChat>
      <d2p1:IsRecvMatching>false</d2p1:IsRecvMatching>
      <d2p1:IsSenderMatching>false</d2p1:IsSenderMatching>
      <d2p1:JoinGroupChat>
        <d2p1:UserId>0</d2p1:UserId>
        <d2p1:Value>String</d2p1:Value>
      </d2p1:JoinGroupChat>
      <d2p1:LeaveGroupChat>
        <d2p1:UserId>0</d2p1:UserId>
        <d2p1:Value>String</d2p1:Value>
      </d2p1:LeaveGroupChat>
      <d2p1:ProfilePhotoComment>
        <d2p1:FullURL>String</d2p1:FullURL>
        <d2p1:PhotoID>String</d2p1:PhotoID>
        <d2p1:ThumbURL>String</d2p1:ThumbURL>
        <d2p1:UserID>0</d2p1:UserID>
      </d2p1:ProfilePhotoComment>
      <d2p1:QuotedMessage>
        <d2p1:RefDisplayName>String</d2p1:RefDisplayName>
        <d2p1:RefMsgExpTs>0</d2p1:RefMsgExpTs>
        <d2p1:RefMsgId>String</d2p1:RefMsgId>
        <d2p1:RefMsgShortDesc>String</d2p1:RefMsgShortDesc>
        <d2p1:RefMsgTitle>String</d2p1:RefMsgTitle>
        <d2p1:RefMsgType>String</d2p1:RefMsgType>
        <d2p1:RefUserId>0</d2p1:RefUserId>
      </d2p1:QuotedMessage>
      <d2p1:Reactions>
        <d2p1:Clear>false</d2p1:Clear>
        <d2p1:ToMsgId>String</d2p1:ToMsgId>
        <d2p1:Unicode>String</d2p1:Unicode>
      </d2p1:Reactions>
      <d2p1:RecvMemberLevel>0</d2p1:RecvMemberLevel>
      <d2p1:RemovedFromGroup>
        <d2p1:UserId>0</d2p1:UserId>
        <d2p1:Value>String</d2p1:Value>
      </d2p1:RemovedFromGroup>
      <d2p1:SenderMemberLevel>0</d2p1:SenderMemberLevel>
      <d2p1:ShareDate>
        <d2p1:Id>0</d2p1:Id>
      </d2p1:ShareDate>
      <d2p1:ShareEvent>
        <d2p1:Id>0</d2p1:Id>
      </d2p1:ShareEvent>
      <d2p1:ShareEventTicket>
        <d2p1:Id>0</d2p1:Id>
      </d2p1:ShareEventTicket>
      <d2p1:ShareLocation>
        <d2p1:Latitude>0</d2p1:Latitude>
        <d2p1:Longitude>0</d2p1:Longitude>
      </d2p1:ShareLocation>
      <d2p1:Text>String</d2p1:Text>
      <d2p1:Video>
        <d2p1:RequestType>String</d2p1:RequestType>
        <d2p1:Value>String</d2p1:Value>
      </d2p1:Video>
      <d2p1:VideoFile>
        <d2p1:Duration>0</d2p1:Duration>
        <d2p1:OwnerUserId>0</d2p1:OwnerUserId>
        <d2p1:ThumbUrl>String</d2p1:ThumbUrl>
        <d2p1:VideoId>0</d2p1:VideoId>
      </d2p1:VideoFile>
    </d2p1:Data>
    <d2p1:FromJid>String</d2p1:FromJid>
    <d2p1:MsgId>String</d2p1:MsgId>
    <d2p1:MsgType>String</d2p1:MsgType>
    <d2p1:Time>0</d2p1:Time>
    <d2p1:ToJid>String</d2p1:ToJid>
  </MessageDetail>
  <NotificationType>Message</NotificationType>
  <OriginalMessageID>0</OriginalMessageID>
  <Receiver>0</Receiver>
</CreateNotificationMessage>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <Authorisation>
    <CanSend>false</CanSend>
    <CanSendGifts>false</CanSendGifts>
    <CanSendPhotos>false</CanSendPhotos>
    <CanVideoCall>false</CanVideoCall>
    <ConversationKey>String</ConversationKey>
    <DefEn>String</DefEn>
    <Detail>String</Detail>
    <IsCreditSend>false</IsCreditSend>
    <MessageBanExpiry>0001-01-01T00:00:00</MessageBanExpiry>
    <Reason>Authorised</Reason>
    <ReceiverIsDiamond>false</ReceiverIsDiamond>
    <ReceiverMemberLevel xmlns:d3p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
      <d3p1:ListID>0</d3p1:ListID>
      <d3p1:Text>String</d3p1:Text>
      <d3p1:TextAbbr>String</d3p1:TextAbbr>
      <d3p1:Value>0</d3p1:Value>
    </ReceiverMemberLevel>
    <ReceiverProfileMatching>false</ReceiverProfileMatching>
    <Remaining>0</Remaining>
    <RemainingCredits>0</RemainingCredits>
    <SendPhotosBanExpiry>0001-01-01T00:00:00</SendPhotosBanExpiry>
    <SenderIsDiamond>false</SenderIsDiamond>
    <SenderMemberLevel xmlns:d3p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
      <d3p1:ListID>0</d3p1:ListID>
      <d3p1:Text>String</d3p1:Text>
      <d3p1:TextAbbr>String</d3p1:TextAbbr>
      <d3p1:Value>0</d3p1:Value>
    </SenderMemberLevel>
    <SenderProfileMatching>false</SenderProfileMatching>
    <TimeStamp>0001-01-01T00:00:00</TimeStamp>
    <TimeToReset>0</TimeToReset>
    <UpgradeAction>None</UpgradeAction>
  </Authorisation>
  <ErrorCode>String</ErrorCode>
  <ErrorMsg>String</ErrorMsg>
  <Success>false</Success>
</CreateMessageResponse>