RHP_API

<back to all web services

CreateNotificationGroupMessage

Requires Authentication
The following routes are available for this service:
POST/User/Notification/GroupMessage
CreateNotificationGroupMessage Parameters:
NameParameterData TypeRequiredDescription
RoomJIDbodystringNo
MessagebodystringNo
MediaIDbodyintNo
MediaTypebodyMediaTypeNo
MessageDetailbodyDetailNo
Detail Parameters:
NameParameterData TypeRequiredDescription
FromJidformstringNo
ToJidformstringNo
MsgIdformstringNo
MsgTypeformstringNo
DataformMsgBodyNo
TimeformlongNo
ChatTypeformstringNo
ConvIdformintNo
MsgBody Parameters:
NameParameterData TypeRequiredDescription
TextformstringNo
ImageformImageNo
VideoFileformVideoFileNo
GalleryformGalleryNo
GiftformGiftNo
GifformGifNo
VideoformVideoNo
ReactionsformReactionNo
ShareLocationformShareLocationNo
ShareDateformShareDateNo
ShareEventformShareEventNo
ShareEventTicketformShareEventNo
QuotedMessageformQuotedMessageNo
ExptsformlongNo
IsRecvMatchingformboolNo
IsSenderMatchingformboolNo
SenderMemberLevelformintNo
RecvMemberLevelformintNo
InviteGroupChatformInviteGroupChatNo
JoinGroupChatformJoinGroupChatNo
LeaveGroupChatformLeaveGroupChatNo
RemovedFromGroupformRemovedFromGroupNo
ProfilePhotoCommentformProfilePhotoCommentNo
InviteGroupformInviteGroupNo
Image Parameters:
NameParameterData TypeRequiredDescription
PhotoIdformintNo
ThumbUrlformstringNo
FullUrlformstringNo
VideoFile Parameters:
NameParameterData TypeRequiredDescription
VideoIdformintNo
ThumbUrlformstringNo
DurationformintNo
OwnerUserIdformlongNo
Gallery Parameters:
NameParameterData TypeRequiredDescription
GalleryIdformintNo
ImageCountformintNo
NameformstringNo
friendIdformlongNo
hasRestrictedformboolNo
isGrantedformboolNo
isPublicformboolNo
Gift Parameters:
NameParameterData TypeRequiredDescription
GiftIdformintNo
NameformstringNo
DescriptionformstringNo
DiamondsformintNo
LevelformintNo
PriceformintNo
DataformstringNo
ImageUrlformstringNo
Gif Parameters:
NameParameterData TypeRequiredDescription
FixedWidthformstringNo
OriginalformstringNo
Video Parameters:
NameParameterData TypeRequiredDescription
RequestTypeformstringNo
ValueformstringNo
Reaction Parameters:
NameParameterData TypeRequiredDescription
ToMsgIdformstringNo
UnicodeformstringNo
ClearformboolNo
ShareLocation Parameters:
NameParameterData TypeRequiredDescription
LatitudeformdoubleNo
LongitudeformdoubleNo
ShareDate Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ShareEvent Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
QuotedMessage Parameters:
NameParameterData TypeRequiredDescription
RefMsgIdformstringNo
RefUserIdformlongNo
RefMsgTypeformstringNo
RefMsgShortDescformstringNo
RefDisplayNameformstringNo
RefMsgExpTsformlongNo
RefMsgTitleformstringNo
InviteGroupChat Parameters:
NameParameterData TypeRequiredDescription
RoomJIDformstringNo
ValueformstringNo
JoinGroupChat Parameters:
NameParameterData TypeRequiredDescription
UserIdformlongNo
ValueformstringNo
LeaveGroupChat Parameters:
NameParameterData TypeRequiredDescription
UserIdformlongNo
ValueformstringNo
RemovedFromGroup Parameters:
NameParameterData TypeRequiredDescription
UserIdformlongNo
ValueformstringNo
ProfilePhotoComment Parameters:
NameParameterData TypeRequiredDescription
UserIDformlongNo
PhotoIDformstringNo
ThumbURLformstringNo
FullURLformstringNo
InviteGroup Parameters:
NameParameterData TypeRequiredDescription
GroupIDformintNo
ValueformstringNo
CreateGroupMessageResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
ErrorCodeformstringNo
ErrorMsgformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"RoomJID":"String","Message":"String","MediaID":0,"MediaType":"Undefined","MessageDetail":{"fromJid":"String","toJid":"String","msgId":"String","msgType":"String","data":{"text":"String","image":{"photoId":0,"thumbUrl":"String","fullUrl":"String"},"videoFile":{"videoId":0,"thumbUrl":"String","duration":0,"ownerUserId":0},"gallery":{"galleryId":0,"imageCount":0,"name":"String","friendId":0,"hasRestricted":false,"isGranted":false,"isPublic":false},"gift":{"giftId":0,"name":"String","description":"String","diamonds":0,"level":0,"price":0,"data":"String","imageUrl":"String"},"gif":{"fixedWidth":"String","original":"String"},"video":{"requestType":"String","value":"String"},"reactions":{"toMsgId":"String","unicode":"String","clear":false},"shareLocation":{"latitude":0,"longitude":0},"shareDate":{"id":0},"shareEvent":{"id":0},"shareEventTicket":{"id":0},"quotedMessage":{"refMsgId":"String","refUserId":0,"refMsgType":"String","refMsgShortDesc":"String","refDisplayName":"String","refMsgExpTs":0,"refMsgTitle":"String"},"expts":0,"isRecvMatching":false,"isSenderMatching":false,"senderMemberLevel":0,"recvMemberLevel":0,"inviteGroupChat":{"roomJid":"String","value":"String"},"joinGroupChat":{"userId":0,"value":"String"},"leaveGroupChat":{"userId":0,"value":"String"},"removedFromGroup":{"userId":0,"value":"String"},"profilePhotoComment":{"userId":0,"photoId":"String","thumbUrl":"String","fullUrl":"String"},"inviteGroup":{"groupId":0,"value":"String"}},"time":0,"chatType":"String","convId":0}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Success":false,"ErrorCode":"String","ErrorMsg":"String"}