POST api/SendMessage_V3/OptInBulk

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerId	integer	None.
Password	string	None.
ShortCode	string	None.
SchoolName	string	None.
Recipients	Collection of OptInBulkRecipient	None.
Keyword	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "Password": "sample string 2",
  "ShortCode": "sample string 3",
  "SchoolName": "sample string 4",
  "Recipients": [
    {
      "RecipientNumber": "sample string 1",
      "RecipientName": "sample string 2"
    },
    {
      "RecipientNumber": "sample string 1",
      "RecipientName": "sample string 2"
    }
  ],
  "Keyword": "sample string 5"
}

application/xml, text/xml

Sample:

<OptInBulkRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.groupcall.alert.azure">
  <CustomerId>1</CustomerId>
  <Keyword>sample string 5</Keyword>
  <Password>sample string 2</Password>
  <Recipients>
    <OptInBulkRecipient>
      <RecipientName>sample string 2</RecipientName>
      <RecipientNumber>sample string 1</RecipientNumber>
    </OptInBulkRecipient>
    <OptInBulkRecipient>
      <RecipientName>sample string 2</RecipientName>
      <RecipientNumber>sample string 1</RecipientNumber>
    </OptInBulkRecipient>
  </Recipients>
  <SchoolName>sample string 4</SchoolName>
  <ShortCode>sample string 3</ShortCode>
</OptInBulkRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OptInBulkResponse

Name	Description	Type	Additional information
ShortCode		string	None.
Responses		Collection of OptInResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "ShortCode": "sample string 1",
  "Responses": [
    {
      "ShortCode": "sample string 1",
      "RecipientNumber": "sample string 2",
      "IsOptedIn": 3,
      "Message": "sample string 4"
    },
    {
      "ShortCode": "sample string 1",
      "RecipientNumber": "sample string 2",
      "IsOptedIn": 3,
      "Message": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<OptInBulkResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.groupcall.alert.azure">
  <Responses>
    <OptInResponse>
      <IsOptedIn>3</IsOptedIn>
      <Message>sample string 4</Message>
      <RecipientNumber>sample string 2</RecipientNumber>
      <ShortCode>sample string 1</ShortCode>
    </OptInResponse>
    <OptInResponse>
      <IsOptedIn>3</IsOptedIn>
      <Message>sample string 4</Message>
      <RecipientNumber>sample string 2</RecipientNumber>
      <ShortCode>sample string 1</ShortCode>
    </OptInResponse>
  </Responses>
  <ShortCode>sample string 1</ShortCode>
</OptInBulkResponse>