POST api/v1/sms/standardmessages/recurringmessages

This method setups a standard recurring message using the 2sms XML Gateway.

Request Information

URI Parameters

None.

Body Parameters

RecurringMessage
NameDescriptionTypeAdditional information
Contacts

List of contacts either individual or group contacts

ContactsIncQuick

None.

Content

The actual message for the contacts to view.

string

Required

DeliverToValidated

Dertemines if the message should be delivered to only validated contacts.

boolean

None.

Header

Optional if the account has a header

string

None.

OccurrencesEnd

Optional : If ReccurrenceRange is to be ended by specific specific count of occurrences, then provide this information.

integer

None.

PatternScheduleDays

Days of the week to scheduled to send the sms

Collection of string

None.

Reference

Stores a reference for the message.

string

Required

StartSend

string

None.

RecurrenceRange

Dertemines how to end the reccuring message

RecurrenceRange

None.

Request Formats

application/json, text/json

Sample:
{
  "Contacts": {
    "ContactID": {
      "sample string 1": 0,
      "sample string 2": 0
    },
    "GroupID": {
      "sample string 1": 0,
      "sample string 2": 0
    },
    "QuickRecipients": {
      "sample string 1": 0,
      "sample string 2": 0
    }
  },
  "Content": "sample string 1",
  "DeliverToValidated": true,
  "Header": "sample string 3",
  "OccurrencesEnd": 4,
  "PatternScheduleDays": [
    "sample string 1",
    "sample string 2"
  ],
  "Reference": "sample string 5",
  "StartSend": "sample string 6",
  "RecurrenceRange": 0
}

Response Information

Resource Description

Sms Transaction

ResponseOfObject
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfObject

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": {}
  }
}

application/xml, text/xml

Sample:
<ResponseOfObject 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 />
  </ResponseData>
</ResponseOfObject>