POST api/v1/sms/messages/fof

Sends a FOF Message to a group of people.

Request Information

URI Parameters

None.

Body Parameters

The FOF Message along with the list of messages.

TwoSms.CustomerPortalRole.API.SMS.FOFMessage
NameDescriptionTypeAdditional information
Groups

List of groups to send the message.

Collection of globally unique identifier

Required

Text

The contents of the message.

string

Required

Request Formats

application/json, text/json

Sample:
{
  "Groups": [
    "2261bfd9-c121-4dc3-a3d3-464136c79c95",
    "696d3142-6801-4e58-9d82-450c95a58105"
  ],
  "Text": "sample string 1"
}

application/xml, text/xml

Sample:
<FOFMessage xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Groups>
    <guid>2261bfd9-c121-4dc3-a3d3-464136c79c95</guid>
    <guid>696d3142-6801-4e58-9d82-450c95a58105</guid>
  </Groups>
  <Text>sample string 1</Text>
</FOFMessage>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The response of the message.

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.SMS.SmsTransaction
NameDescriptionTypeAdditional information
Error

TwoSms.CustomerPortalRole.API.Misc.Error

None.

ResponseData

TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.SMS.SmsTransaction

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {
      "MessageID": "sample string 1",
      "NoOfContacts": "sample string 2",
      "NoOfQuickRecipients": "sample string 3",
      "NoOfSMS": "sample string 4",
      "NoOfEmails": "sample string 5",
      "PreTransaction": "sample string 6",
      "PostTransaction": "sample string 7",
      "CreditsUsed": "sample string 8",
      "MessageText": "sample string 9"
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfSmsTransaction xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <MessageID>sample string 1</MessageID>
      <NoOfContacts>sample string 2</NoOfContacts>
      <NoOfQuickRecipients>sample string 3</NoOfQuickRecipients>
      <NoOfSMS>sample string 4</NoOfSMS>
      <NoOfEmails>sample string 5</NoOfEmails>
      <PreTransaction>sample string 6</PreTransaction>
      <PostTransaction>sample string 7</PostTransaction>
      <CreditsUsed>sample string 8</CreditsUsed>
      <MessageText>sample string 9</MessageText>
    </Detail>
  </ResponseData>
</ResponseOfSmsTransaction>