Required role: | Approved |
All Verbs | /Chat/SendTextMessage/ | ||
---|---|---|---|
All Verbs | /Chat/SendChatMessage/ |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Message | query | ChatMessage | No | |
UploadBase64 | query | string | No | |
UploadBlob | query | byte[] | No | |
SenderSocketId | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
start | form | DateTime | No | |
DeviceUUID | form | string | No | |
APIKey | form | string | No | |
isAdmin | form | bool | No | |
Cmd | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Message | form | ChatMessage | No | |
Chat | form | ChatSession | No | |
UserList | form | List<int> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Result | form | bool | No | |
ResMessage | form | string | No | |
Error | form | Error | No | |
PageInfo | form | BasePageInfo | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ErrorYn | form | bool | No | |
ExYn | form | bool | No | |
ErrorCode | form | string | No | |
ErrorDescription | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TotalRecordCount | form | int | No | |
TotalPageCount | form | int | No | |
CurrentPage | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | ObjectId | No | |
ChatId | form | ObjectId | No | |
SeqId | form | int | No | |
SenderId | form | int | No | |
StoreId | form | int? | No | |
BuyerId | form | int? | No | |
BuyerName | form | string | No | |
ReceiverId | form | int? | No | |
Date | form | DateTime | No | |
Type | form | MessageTypes | No | |
Text | form | string | No | |
Media | form | ChatMedia | No | |
Location | form | GeoLocation | No | |
Location2 | form | GeoLocation | No | |
RefNo | form | string | No |
Name | Value |
---|---|
Text | 1 |
Media | 2 |
Location | 3 |
Basket | 4 |
PaymentRequest | 11 |
Payment | 12 |
Approve | 21 |
Review | 22 |
Auto | 101 |
Cargo | 102 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | ObjectId | No | |
MediaType | form | MediaTypes | No | |
FileName | form | string | No | |
Source | form | string | No | |
MediaMime | form | string | No | |
Url | form | string | No |
Name | Value |
---|---|
icon | 0 |
Image | 1 |
Video | 2 |
Youtube | 3 |
8 | |
File | 9 |
ThreeD | 10 |
Custom | 99 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Lon | form | string | No | |
Lat | form | string | No | |
GeoAddress | form | string | No | |
IsDeleted | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | ObjectId | No | |
StoreId | form | int? | No | |
StoreMediaId | form | int? | No | |
MediaFileName | form | string | No | |
SalerId | form | int? | No | |
BuyerId | form | int? | No | |
SalerDesc | form | string | No | |
BuyerDesc | form | string | No | |
StartDate | form | DateTime | No | |
LastMessageDate | form | DateTime | No | |
LastSeqId | form | int | No | |
CpSeqId | form | int | No | |
MessageCount | form | int | No | |
Status | form | ChatStatuses | No | |
ChatType | form | ChatTypes | No | |
Users | form | List<ChatUser> | No | |
LastMessage | form | string | No | |
BGColor | form | string | No | |
PostId | form | int? | No | |
BasketId | form | int | No |
Name | Value |
---|---|
Active | 1 |
WaitForSalerAction | 2 |
WaitForBuyerAction | 3 |
WaitForAdminAction | 4 |
WaitForRateAction | 5 |
WaitForShipAction | 6 |
ShipmentReturned | 7 |
Completed | 10 |
Archived | 11 |
Deleted | 99 |
Name | Value |
---|---|
Sale | 1 |
P2P | 2 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserId | form | int | No | |
UserName | form | string | No | |
Avatar | form | string | No | |
LastReadSeqId | form | int | No | |
ActiveYn | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Message | form | ChatMessage | No | |
Chat | form | ChatSession | No | |
UserList | form | List<int> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Chat/SendTextMessage/ HTTP/1.1
Host: baseservices.needion.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Message":{"Id":"000000000000000000000000","ChatId":"000000000000000000000000","SeqId":0,"SenderId":0,"StoreId":0,"BuyerId":0,"BuyerName":"String","ReceiverId":0,"Date":"\/Date(-62135596800000-0000)\/","Type":1,"Text":"String","Media":{"Id":"000000000000000000000000","MediaType":0,"FileName":"String","Source":"String","MediaMime":"String","Url":"String"},"Location":{"Lon":"String","Lat":"String","GeoAddress":"String","IsDeleted":false},"Location2":{"Lon":"String","Lat":"String","GeoAddress":"String","IsDeleted":false},"RefNo":"String"},"UploadBase64":"String","UploadBlob":"AA==","SenderSocketId":"String","start":"\/Date(-62135596800000-0000)\/","DeviceUUID":"String","APIKey":"String","isAdmin":false,"Cmd":"String"}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"Message":{"Id":"000000000000000000000000","ChatId":"000000000000000000000000","SeqId":0,"SenderId":0,"StoreId":0,"BuyerId":0,"BuyerName":"String","ReceiverId":0,"Date":"\/Date(-62135596800000-0000)\/","Type":1,"Text":"String","Media":{"Id":"000000000000000000000000","MediaType":0,"FileName":"String","Source":"String","MediaMime":"String","Url":"String"},"Location":{"Lon":"String","Lat":"String","GeoAddress":"String","IsDeleted":false},"Location2":{"Lon":"String","Lat":"String","GeoAddress":"String","IsDeleted":false},"RefNo":"String"},"Chat":{"Id":"000000000000000000000000","StoreId":0,"StoreMediaId":0,"MediaFileName":"String","SalerId":0,"BuyerId":0,"SalerDesc":"String","BuyerDesc":"String","StartDate":"\/Date(-62135596800000-0000)\/","LastMessageDate":"\/Date(-62135596800000-0000)\/","LastSeqId":0,"CpSeqId":0,"MessageCount":0,"Status":1,"ChatType":1,"Users":[{"UserId":0,"UserName":"String","Avatar":"String","LastReadSeqId":0,"ActiveYn":0}],"LastMessage":"String","BGColor":"String","PostId":0,"BasketId":0},"UserList":[0],"Result":false,"ResMessage":"String","Error":{"ErrorYn":false,"ExYn":false,"ErrorCode":"String","ErrorDescription":"String"},"PageInfo":{"TotalRecordCount":0,"TotalPageCount":0,"CurrentPage":0}}