POST api/Tools/AnalyseText

This method is used to analyse text Message before you send, like if you want to determine whether the text message contains unicode characters or not.

Request Information

URI Parameters

None.

Body Parameters

MessageParam
NameDescriptionTypeAdditional information
textMessage

is the message content of the SMS

string

Required

Data type: Text

CalculateParts

is used to get message parts if you set it as true

boolean

Required

Request Formats

application/json, text/json

Sample:
{
  "textMessage": "sample string 1",
  "CalculateParts": true
}

application/xml, text/xml

Sample:
<ToolsModels.MessageParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sms_api.Models">
  <CalculateParts>true</CalculateParts>
  <textMessage>sample string 1</textMessage>
</ToolsModels.MessageParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Details
NameDescriptionTypeAdditional information
TextMessage

string

None.

TextLength

integer

None.

TotalCharacters

integer

None.

TotalSMS

integer

None.

IsGMS7Bit

boolean

None.

BasicSet

Collection of character

None.

ExtensionSet

Collection of character

None.

UnicodeSet

Collection of character

None.

MessageParts

Collection of string

None.

IsMultipart

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "TextMessage": "sample string 1",
  "TextLength": 2,
  "TotalCharacters": 3,
  "TotalSMS": 4,
  "IsGMS7Bit": true,
  "BasicSet": [
    "A",
    "A"
  ],
  "ExtensionSet": [
    "A",
    "A"
  ],
  "UnicodeSet": [
    "A",
    "A"
  ],
  "MessageParts": [
    "sample string 1",
    "sample string 2"
  ],
  "IsMultipart": true
}

application/xml, text/xml

Sample:
<Details xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GSM7Bit">
  <BasicSet xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:char>65</d2p1:char>
    <d2p1:char>65</d2p1:char>
  </BasicSet>
  <ExtensionSet xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:char>65</d2p1:char>
    <d2p1:char>65</d2p1:char>
  </ExtensionSet>
  <IsGMS7Bit>true</IsGMS7Bit>
  <IsMultipart>true</IsMultipart>
  <MessageParts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </MessageParts>
  <TextLength>2</TextLength>
  <TextMessage>sample string 1</TextMessage>
  <TotalCharacters>3</TotalCharacters>
  <TotalSMS>4</TotalSMS>
  <UnicodeSet xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:char>65</d2p1:char>
    <d2p1:char>65</d2p1:char>
  </UnicodeSet>
</Details>