Reference for http://services.mailup.com/API/v1.1/rest/ConsoleService.svc/Console/Sms/List/{ID_LIST}/Recipients/SmsOptins
Retrieve the recipients in the specified list (both subscribed and unsubscribed), including all sub/unsub details, for Sms channel.
Url: http://services.mailup.com/API/v1.1/rest/ConsoleService.svc/Console/Sms/List/{ID_LIST}/Recipients/SmsOptins
HTTP Method: GET
This operation supports JSONP responses. The callback function can be specified using the "callback" Url query parameter.
| Message direction | Format | Body |
|---|---|---|
| Request | N/A | The Request body is empty. |
| Response | Xml | Example,Schema |
| Response | Json | Example |
The following is an example response Xml body:
<CollectionOfConsoleSmOptin xmlns="http://MailupSoa.Ws.Schema.API">
<IsPaginated>true</IsPaginated>
<Items>
<ConsoleSmOptin xmlns="http://MailupSoa.Ws.Schema.API.Console">
<MobileNumber>String content</MobileNumber>
<MobilePrefix>String content</MobilePrefix>
<Optin_Date>String content</Optin_Date>
<Optin_Request_Date>String content</Optin_Request_Date>
<Optin_Request_IP>String content</Optin_Request_IP>
<Optout_Date>String content</Optout_Date>
<Optout_MsgID>2147483647</Optout_MsgID>
<Optout_Type>2147483647</Optout_Type>
<Status>String content</Status>
<idRecipient>2147483647</idRecipient>
</ConsoleSmOptin>
<ConsoleSmOptin xmlns="http://MailupSoa.Ws.Schema.API.Console">
<MobileNumber>String content</MobileNumber>
<MobilePrefix>String content</MobilePrefix>
<Optin_Date>String content</Optin_Date>
<Optin_Request_Date>String content</Optin_Request_Date>
<Optin_Request_IP>String content</Optin_Request_IP>
<Optout_Date>String content</Optout_Date>
<Optout_MsgID>2147483647</Optout_MsgID>
<Optout_Type>2147483647</Optout_Type>
<Status>String content</Status>
<idRecipient>2147483647</idRecipient>
</ConsoleSmOptin>
</Items>
<PageNumber>2147483647</PageNumber>
<PageSize>2147483647</PageSize>
<Skipped>2147483647</Skipped>
<TotalElementsCount>2147483647</TotalElementsCount>
</CollectionOfConsoleSmOptin>
The following is an example response Json body:
{
"IsPaginated":true,
"Items":[{
"MobileNumber":"String content",
"MobilePrefix":"String content",
"Optin_Date":"String content",
"Optin_Request_Date":"String content",
"Optin_Request_IP":"String content",
"Optout_Date":"String content",
"Optout_MsgID":2147483647,
"Optout_Type":2147483647,
"Status":"String content",
"idRecipient":2147483647
}],
"PageNumber":2147483647,
"PageSize":2147483647,
"Skipped":2147483647,
"TotalElementsCount":2147483647
}
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://MailupSoa.Ws.Schema.API" elementFormDefault="qualified" targetNamespace="http://MailupSoa.Ws.Schema.API" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://MailupSoa.Ws.Schema.API.Console" />
<xs:import namespace="http://MailupSoa.Ws.API.Schema" />
<xs:complexType name="CollectionOfConsoleSmOptin">
<xs:annotation>
<xs:appinfo>
<GenericType Name="CollectionOf{0}" Namespace="http://MailupSoa.Ws.Schema.API" xmlns="http://schemas.microsoft.com/2003/10/Serialization/">
<GenericParameter Name="ConsoleSmOptin" Namespace="http://MailupSoa.Ws.Schema.API.Console" />
</GenericType>
</xs:appinfo>
</xs:annotation>
<xs:complexContent mixed="false">
<xs:extension xmlns:q1="http://MailupSoa.Ws.API.Schema" base="q1:BaseDataContract">
<xs:sequence>
<xs:element name="IsPaginated" type="xs:boolean" />
<xs:element minOccurs="0" name="Items" nillable="true" xmlns:q2="http://MailupSoa.Ws.Schema.API.Console" type="q2:ArrayOfConsoleSmOptin" />
<xs:element name="PageNumber" type="xs:int" />
<xs:element name="PageSize" type="xs:int" />
<xs:element name="Skipped" type="xs:int" />
<xs:element name="TotalElementsCount" type="xs:int" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="CollectionOfConsoleSmOptin" nillable="true" type="tns:CollectionOfConsoleSmOptin" />
</xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<xs:schema xmlns:tns="http://MailupSoa.Ws.API.Schema" elementFormDefault="qualified" targetNamespace="http://MailupSoa.Ws.API.Schema" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="BaseDataContract">
<xs:sequence />
</xs:complexType>
<xs:element name="BaseDataContract" nillable="true" type="tns:BaseDataContract" />
</xs:schema>
<xs:schema xmlns:tns="http://MailupSoa.Ws.Schema.API.Console" elementFormDefault="qualified" targetNamespace="http://MailupSoa.Ws.Schema.API.Console" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://MailupSoa.Ws.API.Schema" />
<xs:complexType name="ArrayOfConsoleSmOptin">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="ConsoleSmOptin" nillable="true" type="tns:ConsoleSmOptin" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfConsoleSmOptin" nillable="true" type="tns:ArrayOfConsoleSmOptin" />
<xs:complexType name="ConsoleSmOptin">
<xs:complexContent mixed="false">
<xs:extension xmlns:q1="http://MailupSoa.Ws.API.Schema" base="q1:BaseDataContract">
<xs:sequence>
<xs:element name="MobileNumber" nillable="true" type="xs:string" />
<xs:element name="MobilePrefix" nillable="true" type="xs:string" />
<xs:element name="Optin_Date" nillable="true" type="xs:string" />
<xs:element name="Optin_Request_Date" nillable="true" type="xs:string" />
<xs:element name="Optin_Request_IP" nillable="true" type="xs:string" />
<xs:element name="Optout_Date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Optout_MsgID" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="Optout_Type" nillable="true" type="xs:int" />
<xs:element name="Status" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="idRecipient" type="xs:int" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="ConsoleSmOptin" nillable="true" type="tns:ConsoleSmOptin" />
</xs:schema>
<xs:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="schema">
<xs:complexType />
</xs:element>
</xs:schema>