POST api/SendMessage_V3/fetchOptInStatus

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerId	integer	None.
Password	string	None.
ShortCode	string	None.
RecipientNumber	string	None.
SchoolName	string	None.
RecipientName	string	None.
Keyword	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "Password": "sample string 2",
  "ShortCode": "sample string 3",
  "RecipientNumber": "sample string 4",
  "SchoolName": "sample string 5",
  "RecipientName": "sample string 6",
  "Keyword": "sample string 7"
}

application/xml, text/xml

Sample:

<OptInRequest 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 7</Keyword>
  <Password>sample string 2</Password>
  <RecipientName>sample string 6</RecipientName>
  <RecipientNumber>sample string 4</RecipientNumber>
  <SchoolName>sample string 5</SchoolName>
  <ShortCode>sample string 3</ShortCode>
</OptInRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OptInResponse

Name	Type	Additional information
ShortCode	string	None.
RecipientNumber	string	None.
IsOptedIn	integer	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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