Reference for http://api.123-txt.com/Api123WCF.svc/rest/SendSmsAdvanced
Sends an SMS, auth and data in body of request.
Url: http://api.123-txt.com/Api123WCF.svc/rest/SendSmsAdvanced
HTTP Method: POST
Message direction | Format | Body |
---|---|---|
Request | Xml | Example,Schema |
Request | Json | Example |
Response | Xml | Example,Schema |
Response | Json | Example |
The following is an example request Xml body:
<jsonAdvancedSendMessageRequest xmlns="http://schemas.datacontract.org/2004/07/pf.SlickSms.DbLibrary"> <destinations> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string> </destinations> <pass>String content</pass> <replacementSlot>255</replacementSlot> <sms>String content</sms> <source>String content</source> <user>String content</user> </jsonAdvancedSendMessageRequest>
The following is an example request Json body:
{ "destinations":["String content"], "pass":"String content", "replacementSlot":255, "sms":"String content", "source":"String content", "user":"String content" }
The following is an example response Xml body:
<jsonSendSmsReturn xmlns="http://schemas.datacontract.org/2004/07/pf.SlickSms.DbLibrary"> <CountOfInvalidNumbers>2147483647</CountOfInvalidNumbers> <CountOfValidNumbers>2147483647</CountOfValidNumbers> <ErrorMessage>String content</ErrorMessage> <MessageId>1627aea5-8e0a-4371-9022-9b504344e724</MessageId> <MessageIds> <guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">1627aea5-8e0a-4371-9022-9b504344e724</guid> <guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">1627aea5-8e0a-4371-9022-9b504344e724</guid> </MessageIds> <SendSucceeded>true</SendSucceeded> <TotalCreditCost>12678967.543233</TotalCreditCost> <WillNotSend> <DestinationNumberBad> <status>Good</status> <vn>String content</vn> </DestinationNumberBad> <DestinationNumberBad> <status>Good</status> <vn>String content</vn> </DestinationNumberBad> </WillNotSend> <WillSend> <DestinationNumberGood> <destId>1627aea5-8e0a-4371-9022-9b504344e724</destId> <vn>String content</vn> </DestinationNumberGood> <DestinationNumberGood> <destId>1627aea5-8e0a-4371-9022-9b504344e724</destId> <vn>String content</vn> </DestinationNumberGood> </WillSend> </jsonSendSmsReturn>
The following is an example response Json body:
{ "CountOfInvalidNumbers":2147483647, "CountOfValidNumbers":2147483647, "ErrorMessage":"String content", "MessageId":"1627aea5-8e0a-4371-9022-9b504344e724", "MessageIds":["1627aea5-8e0a-4371-9022-9b504344e724"], "SendSucceeded":true, "TotalCreditCost":12678967.543233, "WillNotSend":[{ "status":0, "vn":"String content" }], "WillSend":[{ "destId":"1627aea5-8e0a-4371-9022-9b504344e724", "vn":"String content" }] }
The following is the request Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/pf.SlickSms.DbLibrary" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/pf.SlickSms.DbLibrary" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <xs:complexType name="jsonAdvancedSendMessageRequest"> <xs:sequence> <xs:element minOccurs="0" name="destinations" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfstring" /> <xs:element minOccurs="0" name="pass" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="replacementSlot" type="xs:unsignedByte"> <xs:annotation> <xs:appinfo> <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" /> </xs:appinfo> </xs:annotation> </xs:element> <xs:element minOccurs="0" name="sms" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="source" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="user" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="jsonAdvancedSendMessageRequest" nillable="true" type="tns:jsonAdvancedSendMessageRequest" /> </xs:schema>
Additional request 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://schemas.microsoft.com/2003/10/Serialization/Arrays" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="ArrayOfstring"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="string" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfstring" nillable="true" type="tns:ArrayOfstring" /> </xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema"> <tns:element name="schema"> <tns:complexType /> </tns:element> </tns:schema>
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/pf.SlickSms.DbLibrary" xmlns:ser="http://schemas.microsoft.com/2003/10/Serialization/" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/pf.SlickSms.DbLibrary" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" /> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <xs:complexType name="jsonSendSmsReturn"> <xs:sequence> <xs:element minOccurs="0" name="CountOfInvalidNumbers" type="xs:int" /> <xs:element minOccurs="0" name="CountOfValidNumbers" type="xs:int" /> <xs:element minOccurs="0" name="ErrorMessage" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="MessageId" type="ser:guid" /> <xs:element minOccurs="0" name="MessageIds" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfguid" /> <xs:element minOccurs="0" name="SendSucceeded" type="xs:boolean" /> <xs:element minOccurs="0" name="TotalCreditCost" type="xs:decimal" /> <xs:element minOccurs="0" name="WillNotSend" nillable="true" type="tns:ArrayOfDestinationNumberBad" /> <xs:element minOccurs="0" name="WillSend" nillable="true" type="tns:ArrayOfDestinationNumberGood" /> </xs:sequence> </xs:complexType> <xs:element name="jsonSendSmsReturn" nillable="true" type="tns:jsonSendSmsReturn" /> <xs:complexType name="ArrayOfDestinationNumberBad"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="DestinationNumberBad" nillable="true" type="tns:DestinationNumberBad" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfDestinationNumberBad" nillable="true" type="tns:ArrayOfDestinationNumberBad" /> <xs:complexType name="DestinationNumberBad"> <xs:sequence> <xs:element minOccurs="0" name="status" type="tns:EnumDestinationNumberStatus" /> <xs:element minOccurs="0" name="vn" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="DestinationNumberBad" nillable="true" type="tns:DestinationNumberBad" /> <xs:simpleType name="EnumDestinationNumberStatus"> <xs:restriction base="xs:string"> <xs:enumeration value="Good"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Bad"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="CannotIdentifyCountry"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">3</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="NoRoute"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">4</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Duplicate"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">5</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Circular"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">6</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="ShortCodeStop"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">7</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> <xs:element name="EnumDestinationNumberStatus" nillable="true" type="tns:EnumDestinationNumberStatus" /> <xs:complexType name="ArrayOfDestinationNumberGood"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="DestinationNumberGood" nillable="true" type="tns:DestinationNumberGood" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfDestinationNumberGood" nillable="true" type="tns:ArrayOfDestinationNumberGood" /> <xs:complexType name="DestinationNumberGood"> <xs:sequence> <xs:element minOccurs="0" name="destId" type="ser:guid" /> <xs:element minOccurs="0" name="vn" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="DestinationNumberGood" nillable="true" type="tns:DestinationNumberGood" /> </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://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:ser="http://schemas.microsoft.com/2003/10/Serialization/" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" /> <xs:complexType name="ArrayOfguid"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="guid" type="ser:guid" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfguid" nillable="true" type="tns:ArrayOfguid" /> </xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema"> <tns:element name="schema"> <tns:complexType /> </tns:element> </tns:schema>