POST api/BaseApi
Request Information
URI Parameters
None.
Body Parameters
MessageRequestName | Description | Type | Additional information |
---|---|---|---|
ReceipientId | integer |
None. |
|
MessageTrigger | Collection of string |
None. |
|
Sms | Collection of ChannelsRequest |
None. |
|
ExternalId | string |
None. |
|
RequestedUser | string |
None. |
|
RequestedApp | string |
None. |
|
StatusID | integer |
None. |
|
StatusDate | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "ReceipientId": 1, "MessageTrigger": [ "sample string 1", "sample string 2" ], "Sms": [ { "From": "sample string 1", "To": "sample string 2", "MessageText": "sample string 3", "GroupNumber": "sample string 4", "MemberId": "sample string 5", "Type": "sample string 6" }, { "From": "sample string 1", "To": "sample string 2", "MessageText": "sample string 3", "GroupNumber": "sample string 4", "MemberId": "sample string 5", "Type": "sample string 6" } ], "ExternalId": "sample string 2", "RequestedUser": "sample string 3", "RequestedApp": "sample string 4", "StatusID": 5, "StatusDate": "sample string 6" }
application/xml, text/xml
Sample:
<MessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/botox.webapi.Models.RequestReponse"> <ExternalId>sample string 2</ExternalId> <MessageTrigger xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </MessageTrigger> <ReceipientId>1</ReceipientId> <RequestedApp>sample string 4</RequestedApp> <RequestedUser>sample string 3</RequestedUser> <Sms> <ChannelsRequest> <From>sample string 1</From> <GroupNumber>sample string 4</GroupNumber> <MemberId>sample string 5</MemberId> <MessageText>sample string 3</MessageText> <To>sample string 2</To> <Type>sample string 6</Type> </ChannelsRequest> <ChannelsRequest> <From>sample string 1</From> <GroupNumber>sample string 4</GroupNumber> <MemberId>sample string 5</MemberId> <MessageText>sample string 3</MessageText> <To>sample string 2</To> <Type>sample string 6</Type> </ChannelsRequest> </Sms> <StatusDate>sample string 6</StatusDate> <StatusID>5</StatusID> </MessageRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
booleanResponse Formats
application/json, text/json
Sample:
true
application/xml, text/xml
Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>