POST api/Messages/SendInstantMessage

Sends an instant message to the specified phone number. User must have Send Message permissions.

Request Information

URI Parameters

None.

Body Parameters

The message to send and the number to send it to

Name	Type	Additional information
SessionToken	string	None.
FromNumber	string	None.
ToNumber	string	None.
Message	string	None.

Request Formats

application/json, text/json

Sample:

{
  "SessionToken": "sample string 1",
  "FromNumber": "sample string 2",
  "ToNumber": "sample string 3",
  "Message": "sample string 4"
}

application/xml, text/xml

Sample:

<SendInstantMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMSConnector">
  <FromNumber>sample string 2</FromNumber>
  <Message>sample string 4</Message>
  <SessionToken>sample string 1</SessionToken>
  <ToNumber>sample string 3</ToNumber>
</SendInstantMessageRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A status code and empty string

APIReturnOfSendMessageStatusAndString

Name	Type	Additional information
StatusEnum	SendMessageStatus	None.
Status	string	None.
Result	string	None.

Response Formats

application/json, text/json

Sample:

{
  "StatusEnum": 0,
  "Status": "Success",
  "Result": "sample string 1"
}

application/xml, text/xml

Sample:

<APIReturnOfSendMessageStatusstringArk7AG5L xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMSConnector">
  <Result>sample string 1</Result>
  <StatusEnum>Success</StatusEnum>
</APIReturnOfSendMessageStatusstringArk7AG5L>