Reference for http://api.esms.vn/MainService.svc/xml/ZCC/RequestConsent/
Url: http://api.esms.vn/MainService.svc/xml/ZCC/RequestConsent/
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:
<ZccRequestModel xmlns="http://schemas.datacontract.org/2004/07/AdvertisingAPI.AnonymousModel"> <ApiKey>String content</ApiKey> <CallReason>String content</CallReason> <CallType>String content</CallType> <CallbackUrl>String content</CallbackUrl> <OAID>String content</OAID> <Phone>String content</Phone> <RequestId>String content</RequestId> <SecretKey>String content</SecretKey> <Tag>String content</Tag> <TempID>String content</TempID> <campaignid>String content</campaignid> </ZccRequestModel>
The following is an example request Json body:
{ "ApiKey":"String content", "CallReason":"String content", "CallType":"String content", "CallbackUrl":"String content", "OAID":"String content", "Phone":"String content", "RequestId":"String content", "SecretKey":"String content", "Tag":"String content", "TempID":"String content", "campaignid":"String content" }
The following is an example response Xml body:
<SmsResultModel xmlns="http://schemas.datacontract.org/2004/07/AdvertisingAPI.Model"> <CodeResult>String content</CodeResult> <CountRegenerate>9223372036854775807</CountRegenerate> <ErrorMessage>String content</ErrorMessage> <IsSandbox>String content</IsSandbox> <Message>String content</Message> <PhoneNumberList> <PhoneNumberResult> <NetworkName>String content</NetworkName> <NetworkType>NotFound</NetworkType> <PhoneNumber>String content</PhoneNumber> </PhoneNumberResult> <PhoneNumberResult> <NetworkName>String content</NetworkName> <NetworkType>NotFound</NetworkType> <PhoneNumber>String content</PhoneNumber> </PhoneNumberResult> </PhoneNumberList> <RedisWalletId>9223372036854775807</RedisWalletId> <RedisWalletUse>NOTFOUND</RedisWalletUse> <RedisWalletUseReseller>NOTFOUND</RedisWalletUseReseller> <SMSID>String content</SMSID> <SendStatus>String content</SendStatus> </SmsResultModel>
The following is an example response Json body:
{ "CodeResult":"String content", "CountRegenerate":9223372036854775807, "ErrorMessage":"String content", "IsSandbox":"String content", "Message":"String content", "PhoneNumberList":[{ "NetworkName":"String content", "NetworkType":0, "PhoneNumber":"String content" }], "RedisWalletId":9223372036854775807, "RedisWalletUse":0, "RedisWalletUseReseller":0, "SMSID":"String content", "SendStatus":"String content" }
The following is the request Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/AdvertisingAPI.AnonymousModel" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/AdvertisingAPI.AnonymousModel" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="ZccRequestModel"> <xs:sequence> <xs:element minOccurs="0" name="ApiKey" nillable="true" type="xs:string"> <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="CallReason" nillable="true" type="xs:string"> <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="CallType" nillable="true" type="xs:string"> <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="CallbackUrl" nillable="true" type="xs:string"> <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="OAID" nillable="true" type="xs:string"> <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="Phone" nillable="true" type="xs:string"> <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="RequestId" nillable="true" type="xs:string"> <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="SecretKey" nillable="true" type="xs:string"> <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="Tag" nillable="true" type="xs:string"> <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="TempID" nillable="true" type="xs:string"> <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="campaignid" nillable="true" type="xs:string"> <xs:annotation> <xs:appinfo> <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" /> </xs:appinfo> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> <xs:element name="ZccRequestModel" nillable="true" type="tns:ZccRequestModel" /> </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>
<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/AdvertisingAPI.Model" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/AdvertisingAPI.Model" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.datacontract.org/2004/07/AdvertisingAPI.Constant" /> <xs:complexType name="SmsResultModel"> <xs:sequence> <xs:element minOccurs="0" name="CodeResult" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="CountRegenerate" type="xs:long" /> <xs:element minOccurs="0" name="ErrorMessage" nillable="true" type="xs:string"> <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="IsSandbox" nillable="true" type="xs:string"> <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="Message" nillable="true" type="xs:string"> <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="PhoneNumberList" nillable="true" type="tns:ArrayOfPhoneNumberResult"> <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="RedisWalletId" type="xs:long"> <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="RedisWalletUse" type="tns:TYPE_WALLET"> <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="RedisWalletUseReseller" type="tns:TYPE_WALLET"> <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="SMSID" nillable="true" type="xs:string"> <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="SendStatus" nillable="true" type="xs:string"> <xs:annotation> <xs:appinfo> <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" /> </xs:appinfo> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> <xs:element name="SmsResultModel" nillable="true" type="tns:SmsResultModel" /> <xs:complexType name="ArrayOfPhoneNumberResult"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="PhoneNumberResult" nillable="true" type="tns:PhoneNumberResult" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfPhoneNumberResult" nillable="true" type="tns:ArrayOfPhoneNumberResult" /> <xs:complexType name="PhoneNumberResult"> <xs:sequence> <xs:element minOccurs="0" name="NetworkName" nillable="true" type="xs:string"> <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="NetworkType" xmlns:q1="http://schemas.datacontract.org/2004/07/AdvertisingAPI.Constant" type="q1:EnumNetwork"> <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="PhoneNumber" nillable="true" type="xs:string"> <xs:annotation> <xs:appinfo> <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" /> </xs:appinfo> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> <xs:element name="PhoneNumberResult" nillable="true" type="tns:PhoneNumberResult" /> <xs:simpleType name="TYPE_WALLET"> <xs:restriction base="xs:string"> <xs:enumeration value="NOTFOUND" /> <xs:enumeration value="MAIN_WALLET" /> <xs:enumeration value="PROMOTION_WALLET" /> <xs:enumeration value="FREE_ZNS_WALLET" /> <xs:enumeration value="VIBER_WALLET" /> <xs:enumeration value="MIN_DEPOSIT_WALLET" /> <xs:enumeration value="FREE_ZNS_FOLLOWER_WALLET" /> </xs:restriction> </xs:simpleType> <xs:element name="TYPE_WALLET" nillable="true" type="tns:TYPE_WALLET" /> </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.datacontract.org/2004/07/AdvertisingAPI.Constant" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/AdvertisingAPI.Constant" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:simpleType name="EnumNetwork"> <xs:restriction base="xs:string"> <xs:enumeration value="NotFound" /> <xs:enumeration value="Viettel" /> <xs:enumeration value="Mobifone" /> <xs:enumeration value="Vinaphone" /> <xs:enumeration value="Vietnamobile" /> <xs:enumeration value="Gtel" /> <xs:enumeration value="Itel" /> <xs:enumeration value="Reddi" /> <xs:enumeration value="Global" /> </xs:restriction> </xs:simpleType> <xs:element name="EnumNetwork" nillable="true" type="tns:EnumNetwork" /> </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>