Sign Up Login
Sign Up Login

API Documents

How to use

https://demo.wiredmessage.com/op/api/v1.0/postxml
 
<request>
<auth>
    <authtoken>xxxxxxxxxxxxxxxxxxxx</authtoken>
    <appkey>xxxxxxxxxxxxxxxxxxxx</appkey>
    <apptoken>xxxxxxxxxxxxxxxxxxxx</apptoken>
    <command>wmgateway_authentication</command>
</auth>
<parameter>
    <mapapptoken></mapapptoken>
</parameter>
</request>
Fields Type Description
auth token Text, required Auth token which is generated in organization
appkey Text, required App key which you created app in wired message
apptoken Text, required App token which is generated in app of wired message
command Text, required This is our command name
Handshake API:
 
<request>
<auth>
    <authtoken>xxxxxxxxxxxxxxxxxxxxxxxxxxx</authtoken>
    <appkey>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</appkey>
    <apptoken>xxxxxxxxxxxxxxxxxxxxxx</apptoken>
    <command>wmgateway_authentication</command>
</auth>
<parameter>
    <testhandshake></testhandshake>
</parameter>
</request>
Fields Type Description
auth token Text, required Auth token which is generated in organization
appkey Text, required App key which you created app in wired message
apptoken Text, required App token which is generated in app of wired message
command Text, required This is our command name
Send API : Email
 
<request>
   <auth>
       <authtoken>xxxxxxxxxxxxxxxxxxxxxxxxxxxxx</authtoken>
       <appkey>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</appkey>
       <apptoken>xxxxxxxxxxxxxxxxxxxxxxxxxxxx</apptoken>
      <command>wmgateway_message</command>
   </auth>
    <parameter>
        <send>
        <txn><![CDATA[]]></txn>
        <templateid><![CDATA[]]></templateid>
        <description><![CDATA[]]></description>
        <sendto>
            <recipient>
                <id><![CDATA[]]></id>
                <name><![CDATA[]]></name>
            </recipient>
            ......
            ......  
            ......
        </sendto>
        <sendtocc><![CDATA[]]></sendtocc>
        <sendtobcc><![CDATA[]]></sendtobcc> 
        <grouping><![CDATA[]]></grouping>         
        <variables>
            <variable>
                <name><![CDATA[]]></name>
                <value><![CDATA[]]></value>
                <title><![CDATA[]]></title>
            </variable>
            ......
            ......  
            ......
        </variables>
       <attachments>
            <attachment>
                <filename><![CDATA[]]></filename>
                <base64><![CDATA[]]></base64>
                <url><![CDATA[]]></url>
            </attachment>
            ......
            ......  
            ......
        </attachments>
        <scheduletime><![CDATA[]]></scheduletime> 
        </send>
    </parameter>
</request>
Send API : SMS / Whatsapp
 
<request>
   <auth>
       <authtoken>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</authtoken>
       <appkey>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</appkey>
       <apptoken>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</apptoken>
      <command>wmgateway_message</command>
   </auth>
    <parameter>
        <send>
        <txn><![CDATA[]]></txn>
        <templateid><![CDATA[]]></templateid>
        <description><![CDATA[]]></description>
        <sendto>
            <recipient>
                <id><![CDATA[]]></id>
                <name><![CDATA[]]></name>
            </recipient>
        </sendto>       
        <variables>
            <variable>
                <name><![CDATA[]]></name>
                <value><![CDATA[]]></value>
                <title><![CDATA[]]></title>
            </variable>
            ......
            ......  
            ......
        </variables>
        <scheduletime><![CDATA[]]></scheduletime> 
        </send>
    </parameter>
</request>
Fields Type Description
auth token Text, required Auth token which is generated in organization
appkey Text, required App key which you created app in wired message
apptoken Text, required App token which is generated in app of wired message
command Text, required This is our command name
txn text, optional Txn is Optional
templateid Text, required Templateid which you mapping templates in wired message
description text, optional Description is optional
id text, required Recipient id which you want to send
name text, required Name which you want to send
sendtocc text, optional Send to cc is Optional
sendtbcc text, optional Send to bcc is Optional
grouping text, optional yes, When group message send
scheduletime text, optional schedule time, When message send a specific time Ex:= 16-May-2025 16:01:55
Bulk Message API : 
 
<request>
   <auth>
       <authtoken>xxxxxxxxxxxxxxxxxxxxxxxxxxxxx</authtoken>
       <appkey>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</appkey>
       <apptoken>xxxxxxxxxxxxxxxxxxxxxxxxxxxx</apptoken>
      <command>wmgateway_message</command>
   </auth>
    <parameter>
	<bulksend>
		<templateid><![CDATA[temp1]]></templateid>
		<description><![CDATA[]]></description>
		<txn><![CDATA[]]></txn>
		<scheduletime><![CDATA[]]></scheduletime>
		<sendto>
				
	        <recipient>
		        <id><![CDATA[]]></id>
		        <name><![CDATA[]]></name>
		        <variables>
	            <variable>
		            <name><![CDATA[]]></name>
		            <value><![CDATA[]]></value>
		            <title><![CDATA[]]></title>
	            </variable>
	            ......
                    ......  
                    ......

		        </variables>
	        </recipient>
            ......
            ......  
            ......

		</sendto>
		<sendtocc>
	<recipient>
		<id><![CDATA[]]></id>
		<name><![CDATA[]]></name>
	</recipient>
		......
                ......  
                ......
		</sendtocc>
		<sendtobcc>
	<recipient>
		<id><![CDATA[]]></id>
		<name><![CDATA[]]></name>
	</recipient>
		......
                ......  
                ......
		</sendtobcc>
<attachments>
	<attachment>
		<filename><![CDATA[]]></filename>
		<base64><![CDATA[]]></base64>
		<url><![CDATA[]]></url>
	</attachment>
		......
                ......  
                ......
		</attachments>
	</bulksend>
</parameter>
</request>
Fields Type Description
auth token Text, required Auth token which is generated in organization
appkey Text, required App key which you created app in wired message
apptoken Text, required App token which is generated in app of wired message
command Text, required This is our command name
txn text, optional Txn is Optional
templateid Text, required Templateid which you mapping templates in wired message
description text, optional Description is optional
id text, required Recipient id which you want to send
name text, required Name which you want to send
sendtocc text, optional Send to cc is Optional
sendtbcc text, optional Send to bcc is Optional
grouping text, optional yes, When group message send
scheduletime text, optional schedule time, When message send a specific time Ex:= 16-May-2025 16:01:55
Register Template API :
 
<request>
   <auth>
       <authtoken>xxxxxxxxxxxxxxxxxxxxxxxxxxxxx</authtoken>
       <appkey>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</appkey>
       <apptoken>xxxxxxxxxxxxxxxxxxxxxxxxxxxx</apptoken>
      <command>wmgateway_template</command>
   </auth>
    <parameter>
        <register>
            <templateid><![CDATA[]]></templateid>
            <templatename><![CDATA[]]></templatename>
            <type><![CDATA[]]></type>
            <dltcontentid><![CDATA[]]></dltcontentid>
            <dltentityid><![CDATA[]]> </dltentityid>
            <telemarketingid><![CDATA[]]></telemarketingid>
            <dlttemplateid><![CDATA[]]></dlttemplateid>
            <provider><![CDATA[]]></provider>
            <subject><![CDATA[]]></subject>
            <purpose><![CDATA[]]> </purpose>
            <description><![CDATA[]]></description>
            <body><![CDATA[]]></body>
            <display>
                <framewidth><![CDATA[]]></framewidth>
                <framepadding><![CDATA[]]></framepadding>
                <frameposition><![CDATA[]]></frameposition>
                <bodybackgroundcolor><![CDATA[]]></bodybackgroundcolor>
                <borderwidth><![CDATA[]]></borderwidth>
                <bordercolor><![CDATA[]]></bordercolor>
                <backgroundcolor><![CDATA[]]></backgroundcolor>
            </display>
        </register>
    </parameter>
</request>
Fields Type Description
auth token Text, required Auth token which is generated in organization
appkey Text, required App key which you created app in wired message
apptoken Text, required App token which is generated in app of wired message
command Text, required This is our command name
Type text, required This field tells us what kind of template you are Register like "sms/email/whatsapp"
templateid Text, required Templateid which you mapping templates in wired message
templatename Text, required This is the name of the template you want to register in the wired Message
dlttemplateid Text, required This field is mandatory For WhatsApp type. For SMS and Email type, this field is optional.
provider Text, required This field is mandatory For WhatsApp & SMS type. For Email type, this field is optional.
subject Text, required This field is mandatory For Email type. For WhatsApp & SMS type, this field is optional.
purpose Text, required This field is mandatory For Email type. For WhatsApp & SMS type, this field is optional.
description text, optional Description is optional
body Text, required The value must be the Base64-encoded content of the message body you want to send.
Get Template API : Request
 
<request>
   <auth>
       <authtoken>xxxxxxxxxxxxxxxxxxxxxxxxxxxxx</authtoken>
       <appkey>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</appkey>
       <apptoken>xxxxxxxxxxxxxxxxxxxxxxxxxxxx</apptoken>
      <command>wmgateway_template</command>
   </auth>
    <parameter>
        <get>
            <templateid><![CDATA[]]></templateid>
            <type><![CDATA[]]></type>
        </get>
</parameter>
</request>
Get Template API : Response
 
<response>
    <success><![CDATA[]]></success>
    <command>wmgateway_template</command>
    <requestid></requestid>
    <date></date>
    <responsedata>
        <results>
            <subject><![CDATA[]]></subject>
            <body><![CDATA[]]></body>
            <mappings>
                <app>
                    <name><![CDATA[]]></name>
                    <name><![CDATA[]]></name>
                </app>
            </mappings>
        </results>
    </responsedata>
</response>
Fields Type Description
auth token Text, required Auth token which is generated in organization
appkey Text, required App key which you created app in wired message
apptoken Text, required App token which is generated in app of wired message
command Text, required This is our command name
Type Text, required This field tells us what kind of template you Want To Get like "sms/email/whatsapp"
templateid Text, required Templateid which you mapping templates in wired message

Ready For The Next Level

Click on 'Read More' to take the first step towards transforming your communication strategies with Wired Message.

Read More Wired Message FAQ