POST api/WhatsApp
Request Information
URI Parameters
None.
Body Parameters
WhatsApp| Name | Description | Type | Additional information |
|---|---|---|---|
| uid |
API Login id. |
string |
Required |
| pwd |
API Login password. |
string |
Required |
| mobile |
Comma separated Mobile Numbers to send. |
string |
Required |
| msgtype |
Message Type. Text - for text message Video - for sending Video Document – sending document ( word document, pdf, txt etc) Location – for sharing location Music – for sending Audio messages Image -for sending Images |
string |
Required |
| txtType |
Type of the Message. P - Plain English U - Unicode messages ( if this type is specified then the “txt” parameter value must be a Unicode converted message |
string |
Required |
| mediatype |
Media Type - (For Text messages this will be empty). video/mp4 – for Video message. image/png – for Image message. application/doc – for document message. audio/mpeg – for audio message. for Location message and plain text messages this attribute will be empty |
string |
None. |
| txt |
Message to Send. eg: Hello from Stardotstar |
string |
None. |
| mediadata |
Media Date - (For text messages this attribute will be empty). For document – send the document URL. For Music - send the audio file URL. For Video – send the Video file URL. For images – Send the Image URL. |
string |
None. |
| latitude |
Latitude of the location eg: 13.053450 |
string |
None. |
| longitude |
ongitude of the Location eg: 80.249663 |
string |
None. |
| loc |
Location Name eg: Stardotstar Software Ltd |
string |
None. |
| locaddress |
Location Address - EG: A6 Basement, Gemini Parsn Complex, No.1, Kodambakkam high road, Nungambakkam, Chennai, Tamil Nadu 600006,India |
string |
None. |
| templateinfo |
Template - Templateid and the number of variables input separated by ~character. eg: 1234id~variable one~variable two here~variable3 here~variable 4 here ~etc |
string |
None. |
Request Formats
application/json, text/json
{
"uid": "sample string 1",
"pwd": "sample string 2",
"mobile": "sample string 3",
"msgtype": "sample string 4",
"txtType": "sample string 5",
"mediatype": "sample string 6",
"txt": "sample string 7",
"mediadata": "sample string 8",
"latitude": "sample string 9",
"longitude": "sample string 10",
"loc": "sample string 11",
"locaddress": "sample string 12",
"templateinfo": "sample string 13"
}
application/xml, text/xml
<WhatsApp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/smsintegraAPI.Models"> <latitude>sample string 9</latitude> <loc>sample string 11</loc> <locaddress>sample string 12</locaddress> <longitude>sample string 10</longitude> <mediadata>sample string 8</mediadata> <mediatype>sample string 6</mediatype> <mobile>sample string 3</mobile> <msgtype>sample string 4</msgtype> <pwd>sample string 2</pwd> <templateinfo>sample string 13</templateinfo> <txt>sample string 7</txt> <txtType>sample string 5</txtType> <uid>sample string 1</uid> </WhatsApp>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |