POST api/v1/systems/{systemPhoneNumber}/presentationPhoneNumber/{presentationPhoneNumber}/sms

Send message

Request Information

URI Parameters

Name	Description	Type	Additional information
systemPhoneNumber		string	Required
presentationPhoneNumber		string	Required

Body Parameters

MessageRequest

Name	Type	Additional information
From	string	Required
To	string	Required
Text	string	Required

Request Formats

application/json, text/json

Sample:

{
  "From": "sample string 1",
  "To": "sample string 2",
  "Text": "sample string 3"
}

application/xml, text/xml

Sample:

<MessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FreedomVoice.Entities.Request.Weblink">
  <From>sample string 1</From>
  <Text>sample string 3</Text>
  <To>sample string 2</To>
</MessageRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'MessageRequest'.

Response Information

Resource Description

SendingResponseOfConversation

Name	Type	Additional information
Entity	Conversation	None.
State	SendingState	None.
ErrorMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Entity": {
    "Id": 1,
    "SystemPhoneNumber": {
      "Id": 1,
      "PhoneNumber": "sample string 2"
    },
    "ToPhone": {
      "Id": 1,
      "PhoneNumber": "sample string 2"
    },
    "LastSyncDate": "2024-11-22T01:04:29.5007713-08:00",
    "Messages": [
      {
        "Id": 1,
        "From": {
          "Id": 1,
          "PhoneNumber": "sample string 2"
        },
        "To": {
          "Id": 1,
          "PhoneNumber": "sample string 2"
        },
        "Text": "sample string 2",
        "SentAt": "2024-11-22T01:04:29.5007713-08:00",
        "CreatedAt": "2024-11-22T01:04:29.5007713-08:00",
        "ReadAt": "2024-11-22T01:04:29.5007713-08:00",
        "LastUpdateDate": "2024-11-22T01:04:29.5007713-08:00",
        "State": 0
      },
      {
        "Id": 1,
        "From": {
          "Id": 1,
          "PhoneNumber": "sample string 2"
        },
        "To": {
          "Id": 1,
          "PhoneNumber": "sample string 2"
        },
        "Text": "sample string 2",
        "SentAt": "2024-11-22T01:04:29.5007713-08:00",
        "CreatedAt": "2024-11-22T01:04:29.5007713-08:00",
        "ReadAt": "2024-11-22T01:04:29.5007713-08:00",
        "LastUpdateDate": "2024-11-22T01:04:29.5007713-08:00",
        "State": 0
      }
    ],
    "IsRemoved": true
  },
  "State": 0,
  "ErrorMessage": "sample string 1"
}

application/xml, text/xml

Sample:

<SendingResponseOfConversationtPQ_ScUYb xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FreedomVoice.Entities.Response">
  <ErrorMessage>sample string 1</ErrorMessage>
  <State>Sending</State>
  <Entity>
    <Id>1</Id>
    <IsRemoved>true</IsRemoved>
    <LastSyncDate>2024-11-22T01:04:29.5007713-08:00</LastSyncDate>
    <Messages xmlns:d3p1="http://schemas.datacontract.org/2004/07/FreedomVoice.Entities">
      <d3p1:Message>
        <d3p1:CreatedAt>2024-11-22T01:04:29.5007713-08:00</d3p1:CreatedAt>
        <d3p1:From>
          <d3p1:Id>1</d3p1:Id>
          <d3p1:PhoneNumber>sample string 2</d3p1:PhoneNumber>
        </d3p1:From>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:LastUpdateDate>2024-11-22T01:04:29.5007713-08:00</d3p1:LastUpdateDate>
        <d3p1:ReadAt>2024-11-22T01:04:29.5007713-08:00</d3p1:ReadAt>
        <d3p1:SentAt>2024-11-22T01:04:29.5007713-08:00</d3p1:SentAt>
        <d3p1:State>Sending</d3p1:State>
        <d3p1:Text>sample string 2</d3p1:Text>
        <d3p1:To>
          <d3p1:Id>1</d3p1:Id>
          <d3p1:PhoneNumber>sample string 2</d3p1:PhoneNumber>
        </d3p1:To>
      </d3p1:Message>
      <d3p1:Message>
        <d3p1:CreatedAt>2024-11-22T01:04:29.5007713-08:00</d3p1:CreatedAt>
        <d3p1:From>
          <d3p1:Id>1</d3p1:Id>
          <d3p1:PhoneNumber>sample string 2</d3p1:PhoneNumber>
        </d3p1:From>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:LastUpdateDate>2024-11-22T01:04:29.5007713-08:00</d3p1:LastUpdateDate>
        <d3p1:ReadAt>2024-11-22T01:04:29.5007713-08:00</d3p1:ReadAt>
        <d3p1:SentAt>2024-11-22T01:04:29.5007713-08:00</d3p1:SentAt>
        <d3p1:State>Sending</d3p1:State>
        <d3p1:Text>sample string 2</d3p1:Text>
        <d3p1:To>
          <d3p1:Id>1</d3p1:Id>
          <d3p1:PhoneNumber>sample string 2</d3p1:PhoneNumber>
        </d3p1:To>
      </d3p1:Message>
    </Messages>
    <SystemPhoneNumber xmlns:d3p1="http://schemas.datacontract.org/2004/07/FreedomVoice.Entities">
      <d3p1:Id>1</d3p1:Id>
      <d3p1:PhoneNumber>sample string 2</d3p1:PhoneNumber>
    </SystemPhoneNumber>
    <ToPhone xmlns:d3p1="http://schemas.datacontract.org/2004/07/FreedomVoice.Entities">
      <d3p1:Id>1</d3p1:Id>
      <d3p1:PhoneNumber>sample string 2</d3p1:PhoneNumber>
    </ToPhone>
  </Entity>
</SendingResponseOfConversationtPQ_ScUYb>