POST api/SendMessage_V2/SMS

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
messageData	Collection of MessageData	None.
styleClass	string	None.
sendXpression	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "messageData": [
    {
      "ClientRef": "sample string 1",
      "UserName": "sample string 2",
      "SentByName": "sample string 3",
      "CustomerId": 4,
      "Password": "sample string 5",
      "EmailSentFromName": "sample string 6",
      "EmailSentFromAddress": "sample string 7",
      "EmailReplyToAddress": "sample string 8",
      "EmailSubject": "sample string 9",
      "EmailBody": "sample string 10",
      "SMSSender": "sample string 11",
      "SMSMessage": "sample string 12",
      "NotificationMessage": "sample string 13",
      "XpressionsBody": "sample string 14",
      "SendDateTime": "2025-04-20T00:10:50.7745479+00:00",
      "CallbackUrl": "sample string 15",
      "Recipients": [
        {
          "ClientId": "sample string 1",
          "Id": 1,
          "ExternalId": "sample string 2",
          "StudentId": "sample string 3",
          "StudentExternalId": "sample string 4",
          "SendTo": 0,
          "Forename": "sample string 5",
          "Surname": "sample string 6",
          "EmailAddress": "sample string 7",
          "MobileNumber": "sample string 8",
          "DynamicTokens": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "MessengerId": "sample string 9",
          "StudentMessengerId": "sample string 10",
          "EmailLocationType": "sample string 11",
          "IdaasId": "sample string 12",
          "StudentIdaasId": "sample string 13"
        },
        {
          "ClientId": "sample string 1",
          "Id": 1,
          "ExternalId": "sample string 2",
          "StudentId": "sample string 3",
          "StudentExternalId": "sample string 4",
          "SendTo": 0,
          "Forename": "sample string 5",
          "Surname": "sample string 6",
          "EmailAddress": "sample string 7",
          "MobileNumber": "sample string 8",
          "DynamicTokens": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "MessengerId": "sample string 9",
          "StudentMessengerId": "sample string 10",
          "EmailLocationType": "sample string 11",
          "IdaasId": "sample string 12",
          "StudentIdaasId": "sample string 13"
        }
      ],
      "Attachments": [
        {
          "FileName": "sample string 1",
          "FileData": "sample string 2"
        },
        {
          "FileName": "sample string 1",
          "FileData": "sample string 2"
        }
      ],
      "MessageCategoryId": 16
    },
    {
      "ClientRef": "sample string 1",
      "UserName": "sample string 2",
      "SentByName": "sample string 3",
      "CustomerId": 4,
      "Password": "sample string 5",
      "EmailSentFromName": "sample string 6",
      "EmailSentFromAddress": "sample string 7",
      "EmailReplyToAddress": "sample string 8",
      "EmailSubject": "sample string 9",
      "EmailBody": "sample string 10",
      "SMSSender": "sample string 11",
      "SMSMessage": "sample string 12",
      "NotificationMessage": "sample string 13",
      "XpressionsBody": "sample string 14",
      "SendDateTime": "2025-04-20T00:10:50.7745479+00:00",
      "CallbackUrl": "sample string 15",
      "Recipients": [
        {
          "ClientId": "sample string 1",
          "Id": 1,
          "ExternalId": "sample string 2",
          "StudentId": "sample string 3",
          "StudentExternalId": "sample string 4",
          "SendTo": 0,
          "Forename": "sample string 5",
          "Surname": "sample string 6",
          "EmailAddress": "sample string 7",
          "MobileNumber": "sample string 8",
          "DynamicTokens": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "MessengerId": "sample string 9",
          "StudentMessengerId": "sample string 10",
          "EmailLocationType": "sample string 11",
          "IdaasId": "sample string 12",
          "StudentIdaasId": "sample string 13"
        },
        {
          "ClientId": "sample string 1",
          "Id": 1,
          "ExternalId": "sample string 2",
          "StudentId": "sample string 3",
          "StudentExternalId": "sample string 4",
          "SendTo": 0,
          "Forename": "sample string 5",
          "Surname": "sample string 6",
          "EmailAddress": "sample string 7",
          "MobileNumber": "sample string 8",
          "DynamicTokens": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "MessengerId": "sample string 9",
          "StudentMessengerId": "sample string 10",
          "EmailLocationType": "sample string 11",
          "IdaasId": "sample string 12",
          "StudentIdaasId": "sample string 13"
        }
      ],
      "Attachments": [
        {
          "FileName": "sample string 1",
          "FileData": "sample string 2"
        },
        {
          "FileName": "sample string 1",
          "FileData": "sample string 2"
        }
      ],
      "MessageCategoryId": 16
    }
  ],
  "styleClass": "sample string 1",
  "sendXpression": true
}

application/xml, text/xml

Sample:

<MessageModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.groupcall.alert.azure">
  <messageData>
    <MessageData>
      <Attachments>
        <Attachment>
          <FileData>sample string 2</FileData>
          <FileName>sample string 1</FileName>
        </Attachment>
        <Attachment>
          <FileData>sample string 2</FileData>
          <FileName>sample string 1</FileName>
        </Attachment>
      </Attachments>
      <CallbackUrl>sample string 15</CallbackUrl>
      <ClientRef>sample string 1</ClientRef>
      <CustomerId>4</CustomerId>
      <EmailBody>sample string 10</EmailBody>
      <EmailReplyToAddress>sample string 8</EmailReplyToAddress>
      <EmailSentFromAddress>sample string 7</EmailSentFromAddress>
      <EmailSentFromName>sample string 6</EmailSentFromName>
      <EmailSubject>sample string 9</EmailSubject>
      <MessageCategoryId>16</MessageCategoryId>
      <NotificationMessage>sample string 13</NotificationMessage>
      <Password>sample string 5</Password>
      <Recipients>
        <MessageRecipient>
          <ClientId>sample string 1</ClientId>
          <DynamicTokens xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 1</d6p1:Key>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </DynamicTokens>
          <EmailAddress>sample string 7</EmailAddress>
          <EmailLocationType>sample string 11</EmailLocationType>
          <ExternalId>sample string 2</ExternalId>
          <Forename>sample string 5</Forename>
          <Id>1</Id>
          <IdaasId>sample string 12</IdaasId>
          <MessengerId>sample string 9</MessengerId>
          <MobileNumber>sample string 8</MobileNumber>
          <SendTo>Self</SendTo>
          <StudentExternalId>sample string 4</StudentExternalId>
          <StudentId>sample string 3</StudentId>
          <StudentIdaasId>sample string 13</StudentIdaasId>
          <StudentMessengerId>sample string 10</StudentMessengerId>
          <Surname>sample string 6</Surname>
        </MessageRecipient>
        <MessageRecipient>
          <ClientId>sample string 1</ClientId>
          <DynamicTokens xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 1</d6p1:Key>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </DynamicTokens>
          <EmailAddress>sample string 7</EmailAddress>
          <EmailLocationType>sample string 11</EmailLocationType>
          <ExternalId>sample string 2</ExternalId>
          <Forename>sample string 5</Forename>
          <Id>1</Id>
          <IdaasId>sample string 12</IdaasId>
          <MessengerId>sample string 9</MessengerId>
          <MobileNumber>sample string 8</MobileNumber>
          <SendTo>Self</SendTo>
          <StudentExternalId>sample string 4</StudentExternalId>
          <StudentId>sample string 3</StudentId>
          <StudentIdaasId>sample string 13</StudentIdaasId>
          <StudentMessengerId>sample string 10</StudentMessengerId>
          <Surname>sample string 6</Surname>
        </MessageRecipient>
      </Recipients>
      <SMSMessage>sample string 12</SMSMessage>
      <SMSSender>sample string 11</SMSSender>
      <SendDateTime>2025-04-20T00:10:50.7745479+00:00</SendDateTime>
      <SentByName>sample string 3</SentByName>
      <UserName>sample string 2</UserName>
      <XpressionsBody>sample string 14</XpressionsBody>
    </MessageData>
    <MessageData>
      <Attachments>
        <Attachment>
          <FileData>sample string 2</FileData>
          <FileName>sample string 1</FileName>
        </Attachment>
        <Attachment>
          <FileData>sample string 2</FileData>
          <FileName>sample string 1</FileName>
        </Attachment>
      </Attachments>
      <CallbackUrl>sample string 15</CallbackUrl>
      <ClientRef>sample string 1</ClientRef>
      <CustomerId>4</CustomerId>
      <EmailBody>sample string 10</EmailBody>
      <EmailReplyToAddress>sample string 8</EmailReplyToAddress>
      <EmailSentFromAddress>sample string 7</EmailSentFromAddress>
      <EmailSentFromName>sample string 6</EmailSentFromName>
      <EmailSubject>sample string 9</EmailSubject>
      <MessageCategoryId>16</MessageCategoryId>
      <NotificationMessage>sample string 13</NotificationMessage>
      <Password>sample string 5</Password>
      <Recipients>
        <MessageRecipient>
          <ClientId>sample string 1</ClientId>
          <DynamicTokens xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 1</d6p1:Key>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </DynamicTokens>
          <EmailAddress>sample string 7</EmailAddress>
          <EmailLocationType>sample string 11</EmailLocationType>
          <ExternalId>sample string 2</ExternalId>
          <Forename>sample string 5</Forename>
          <Id>1</Id>
          <IdaasId>sample string 12</IdaasId>
          <MessengerId>sample string 9</MessengerId>
          <MobileNumber>sample string 8</MobileNumber>
          <SendTo>Self</SendTo>
          <StudentExternalId>sample string 4</StudentExternalId>
          <StudentId>sample string 3</StudentId>
          <StudentIdaasId>sample string 13</StudentIdaasId>
          <StudentMessengerId>sample string 10</StudentMessengerId>
          <Surname>sample string 6</Surname>
        </MessageRecipient>
        <MessageRecipient>
          <ClientId>sample string 1</ClientId>
          <DynamicTokens xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 1</d6p1:Key>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </DynamicTokens>
          <EmailAddress>sample string 7</EmailAddress>
          <EmailLocationType>sample string 11</EmailLocationType>
          <ExternalId>sample string 2</ExternalId>
          <Forename>sample string 5</Forename>
          <Id>1</Id>
          <IdaasId>sample string 12</IdaasId>
          <MessengerId>sample string 9</MessengerId>
          <MobileNumber>sample string 8</MobileNumber>
          <SendTo>Self</SendTo>
          <StudentExternalId>sample string 4</StudentExternalId>
          <StudentId>sample string 3</StudentId>
          <StudentIdaasId>sample string 13</StudentIdaasId>
          <StudentMessengerId>sample string 10</StudentMessengerId>
          <Surname>sample string 6</Surname>
        </MessageRecipient>
      </Recipients>
      <SMSMessage>sample string 12</SMSMessage>
      <SMSSender>sample string 11</SMSSender>
      <SendDateTime>2025-04-20T00:10:50.7745479+00:00</SendDateTime>
      <SentByName>sample string 3</SentByName>
      <UserName>sample string 2</UserName>
      <XpressionsBody>sample string 14</XpressionsBody>
    </MessageData>
  </messageData>
  <sendXpression>true</sendXpression>
  <styleClass>sample string 1</styleClass>
</MessageModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of MessageResponse

Name	Type	Additional information
errorMsg	string	None.
MessageSentId	integer	None.
MessageId	string	None.
statusMsg	string	None.
transmitDateTime	date	None.
ClientRef	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "errorMsg": "sample string 1",
    "MessageSentId": 2,
    "MessageId": "sample string 3",
    "statusMsg": "sample string 4",
    "transmitDateTime": "2025-04-20T00:10:50.7901754+00:00",
    "ClientRef": "sample string 5"
  },
  {
    "errorMsg": "sample string 1",
    "MessageSentId": 2,
    "MessageId": "sample string 3",
    "statusMsg": "sample string 4",
    "transmitDateTime": "2025-04-20T00:10:50.7901754+00:00",
    "ClientRef": "sample string 5"
  }
]

application/xml, text/xml

Sample:

<ArrayOfMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.groupcall.alert.azure">
  <MessageResponse>
    <ClientRef>sample string 5</ClientRef>
    <MessageId>sample string 3</MessageId>
    <MessageSentId>2</MessageSentId>
    <errorMsg>sample string 1</errorMsg>
    <statusMsg>sample string 4</statusMsg>
    <transmitDateTime>2025-04-20T00:10:50.7901754+00:00</transmitDateTime>
  </MessageResponse>
  <MessageResponse>
    <ClientRef>sample string 5</ClientRef>
    <MessageId>sample string 3</MessageId>
    <MessageSentId>2</MessageSentId>
    <errorMsg>sample string 1</errorMsg>
    <statusMsg>sample string 4</statusMsg>
    <transmitDateTime>2025-04-20T00:10:50.7901754+00:00</transmitDateTime>
  </MessageResponse>
</ArrayOfMessageResponse>