Reference for http://messaging.cdyne.com/Messaging.svc/AssignKeyword

Url: http://messaging.cdyne.com/Messaging.svc/AssignKeyword

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:

<SMSKeywordRequest xmlns="http://sms2.cdyne.com">
  <LicenseKey>1627aea5-8e0a-4371-9022-9b504344e724</LicenseKey>
  <SMSKeywords>
    <KeywordRequestInfo>
      <Keyword>String content</Keyword>
      <ShortCode>String content</ShortCode>
    </KeywordRequestInfo>
    <KeywordRequestInfo>
      <Keyword>String content</Keyword>
      <ShortCode>String content</ShortCode>
    </KeywordRequestInfo>
  </SMSKeywords>
</SMSKeywordRequest>

The following is an example request Json body:

{
	"LicenseKey":"1627aea5-8e0a-4371-9022-9b504344e724",
	"SMSKeywords":[{
		"Keyword":"String content",
		"ShortCode":"String content"
	}]
}

The following is an example response Xml body:

<SMSKeywordResponse xmlns="http://sms2.cdyne.com">
  <ReturnCode>NoError</ReturnCode>
  <SMSKeyword>
    <KeywordResponseInfo>
      <EntryDate>1999-05-31T11:20:00</EntryDate>
      <Keyword>String content</Keyword>
      <ReturnCode>NoError</ReturnCode>
      <ShortCode>String content</ShortCode>
    </KeywordResponseInfo>
    <KeywordResponseInfo>
      <EntryDate>1999-05-31T11:20:00</EntryDate>
      <Keyword>String content</Keyword>
      <ReturnCode>NoError</ReturnCode>
      <ShortCode>String content</ShortCode>
    </KeywordResponseInfo>
  </SMSKeyword>
</SMSKeywordResponse>

The following is an example response Json body:

{
	"ReturnCode":0,
	"SMSKeyword":[{
		"EntryDate":"\/Date(928164000000-0400)\/",
		"Keyword":"String content",
		"ReturnCode":0,
		"ShortCode":"String content"
	}]
}

The following is the request Xml Schema:

<xs:schema xmlns:tns="http://sms2.cdyne.com" xmlns:ser="http://schemas.microsoft.com/2003/10/Serialization/" elementFormDefault="qualified" targetNamespace="http://sms2.cdyne.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
  <xs:complexType name="SMSKeywordRequest">
    <xs:sequence>
      <xs:element name="LicenseKey" type="ser:guid" />
      <xs:element minOccurs="0" name="SMSKeywords" nillable="true" type="tns:ArrayOfKeywordRequestInfo" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="SMSKeywordRequest" nillable="true" type="tns:SMSKeywordRequest" />
  <xs:complexType name="ArrayOfKeywordRequestInfo">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="KeywordRequestInfo" nillable="true" type="tns:KeywordRequestInfo" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ArrayOfKeywordRequestInfo" nillable="true" type="tns:ArrayOfKeywordRequestInfo" />
  <xs:complexType name="KeywordRequestInfo">
    <xs:sequence>
      <xs:element minOccurs="0" name="Keyword" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="ShortCode" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="KeywordRequestInfo" nillable="true" type="tns:KeywordRequestInfo" />
</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://sms2.cdyne.com" elementFormDefault="qualified" targetNamespace="http://sms2.cdyne.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="SMSKeywordResponse">
    <xs:sequence>
      <xs:element minOccurs="0" name="ReturnCode" type="tns:SMSKeywordReturnCode" />
      <xs:element minOccurs="0" name="SMSKeyword" nillable="true" type="tns:ArrayOfKeywordResponseInfo" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="SMSKeywordResponse" nillable="true" type="tns:SMSKeywordResponse" />
  <xs:simpleType name="SMSKeywordReturnCode">
    <xs:restriction base="xs:string">
      <xs:enumeration value="NoError" />
      <xs:enumeration value="KeywordAdded" />
      <xs:enumeration value="KeywordAlreadyInUse" />
      <xs:enumeration value="ShortCodeNotAssignedToKey" />
      <xs:enumeration value="LicenseKeyInvalid" />
      <xs:enumeration value="KeywordInvalid" />
      <xs:enumeration value="ShortCodeInvalid" />
      <xs:enumeration value="KeywordRemoved" />
      <xs:enumeration value="KeywordNotFound" />
      <xs:enumeration value="InternalError" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="SMSKeywordReturnCode" nillable="true" type="tns:SMSKeywordReturnCode" />
  <xs:complexType name="ArrayOfKeywordResponseInfo">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="KeywordResponseInfo" nillable="true" type="tns:KeywordResponseInfo" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ArrayOfKeywordResponseInfo" nillable="true" type="tns:ArrayOfKeywordResponseInfo" />
  <xs:complexType name="KeywordResponseInfo">
    <xs:sequence>
      <xs:element minOccurs="0" name="EntryDate" type="xs:dateTime" />
      <xs:element minOccurs="0" name="Keyword" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="ReturnCode" type="tns:SMSKeywordReturnCode" />
      <xs:element minOccurs="0" name="ShortCode" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="KeywordResponseInfo" nillable="true" type="tns:KeywordResponseInfo" />
</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>

<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>