DAgentAPI


Click here for a complete list of operations.

UpdateBroadcast

This method update a broadcast and returns the broadcast id.

SchedulerMode values:
0: Manual. You will have to specify the sender IDs separated by comma.
1: All senders. All the available IPs assigned to this user will be used.
2: Server less used. All the IPs associated with the server less used in previous broadcasts will be used.
3: Sender less used. The less used IP of each server will be used (one IP per server).
4: Domain less used. All the IPs related to the domain less used in previous broadcasts will be used. One domain per server.
RedirectBot: The URL where you want false clicks (usually issued by antivirus and antispam software) to be redirected. Example: http://youtube.com

ListsIds: This parameter will contain comma separated groups of list IDs, segment's start and segment's end. Here's a few examples:
Sample value: 20:0:400,17:20:500
Result: 400 recipients starting at record #0, from list ID #20, plus 500 items, starting at record #20, from list ID #17

SuppressionListsIds:
This parameter will contain comma separated pairs with the type of suppression task you want to perform, and the related ID. Here's a couple examples:
Sample value: S:420,M:212,N:2,C:80027
Result: Will suppress against the normal suppression list with ID #420, against the MD5 encrypted suppression list with ID #212, against the normal list with ID #2, and against the openers and clickers from the campaign with ID #80027
Sample value: S:420,S:421,S:1024
Result: Will suppress against the suppression lists with IDs #420, #421 and #1024
Note: S means Standard suppression list, M means MD5 Encrypted suppression list, N means Normal list, and C is used to specify a broadcast ID to suppress against its openers and clickers.

EmailIds: This value must be set with pairs of creative ids and domains you want to set affinity with. Here's some examples
Sample value: 345:aol.com,390:aol.com,393:gmail.com,441:*,442:*
Result: The campaign will be sent with creative 441 and 442 as the default creatives, rotating evenly. Unless the recipient domain is aol.com, and in that case it will send 345 and 390 evenly. Also gmail.com recipients will only receive creative ID 393
Sample value: 120:*
Result: Creative 120 will be sent on this broadcast
Note: At least ONE creative must have affinity with all domains.

XMLFilter: This value is a raw XML structure to build the logic behind the segments you want to send the broadcast to. The following are examples of what you can do
Sample Value:

                        <root>
                          <node label="or" type="group" data="" field="">
                            <node label="equals" type="condition" data="aol.com" field="domain" dbfield="item_domain" item=""/>
                            <node label="equals" type="condition" data="aim.com" field="domain" dbfield="item_domain" item=""/>
                            <node label="equals" type="condition" data="hotmail.com" field="domain" dbfield="item_domain" item=""/>
                            <node label="equals" type="condition" data="live.com" field="domain" dbfield="item_domain" item=""/>
                          </node><br/>
                        </root>
                    

Result: It will send only to recipients at aol.com, aim.com, hotmail.com and live.com

Sample Value:
                        <root>
                          <node label="and" type="group" data="" field="">
                            <node label="does not equal" type="condition" data="aol.com" field="domain" dbfield="item_domain" item=""/>
                            <node label="does not equal" type="condition" data="aim.com" field="domain" dbfield="item_domain" item=""/>
                            <node label="does not equal" type="condition" data="hotmail.com" field="domain" dbfield="item_domain" item=""/>
                            <node label="does not equal" type="condition" data="live.com" field="domain" dbfield="item_domain" item=""/>
                          </node>
                        </root>
                    

Result: It will send to every recipient, EXCEPT for those recipients at aol.com, aim.com, hotmail.com and live.com

Possible label values:
equals
does not equal
is like
is not like
begins with
ends with
contains
does not contains
is greater than
is less than
Use these parameters if you want send your broadcast througth a relay server
relayHost: host:port
relayUser: userName
relayPassword: password

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /DAgentAPI.asmx HTTP/1.1
Host: api.da1pureb2bemail.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.DAgentAPI.com/UpdateBroadcast"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <UpdateBroadcast xmlns="http://api.DAgentAPI.com/">
      <Username>string</Username>
      <Password>string</Password>
      <broadcastId>int</broadcastId>
      <BroadcastName>string</BroadcastName>
      <ListsIds>string</ListsIds>
      <SuppressionListsIds>string</SuppressionListsIds>
      <EmailIds>string</EmailIds>
      <DateScheduled>string</DateScheduled>
      <TimeScheduled>string</TimeScheduled>
      <RedirectBot>string</RedirectBot>
      <Previous>string</Previous>
      <Senders>string</Senders>
      <SchedulerMode>int</SchedulerMode>
      <ReplyTo>string</ReplyTo>
      <MaskDomainsIds>string</MaskDomainsIds>
      <XMLFilter>string</XMLFilter>
      <relayHost>string</relayHost>
      <relayUser>string</relayUser>
      <relayPassword>string</relayPassword>
    </UpdateBroadcast>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <UpdateBroadcastResponse xmlns="http://api.DAgentAPI.com/">
      <UpdateBroadcastResult>xml</UpdateBroadcastResult>
    </UpdateBroadcastResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /DAgentAPI.asmx HTTP/1.1
Host: api.da1pureb2bemail.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <UpdateBroadcast xmlns="http://api.DAgentAPI.com/">
      <Username>string</Username>
      <Password>string</Password>
      <broadcastId>int</broadcastId>
      <BroadcastName>string</BroadcastName>
      <ListsIds>string</ListsIds>
      <SuppressionListsIds>string</SuppressionListsIds>
      <EmailIds>string</EmailIds>
      <DateScheduled>string</DateScheduled>
      <TimeScheduled>string</TimeScheduled>
      <RedirectBot>string</RedirectBot>
      <Previous>string</Previous>
      <Senders>string</Senders>
      <SchedulerMode>int</SchedulerMode>
      <ReplyTo>string</ReplyTo>
      <MaskDomainsIds>string</MaskDomainsIds>
      <XMLFilter>string</XMLFilter>
      <relayHost>string</relayHost>
      <relayUser>string</relayUser>
      <relayPassword>string</relayPassword>
    </UpdateBroadcast>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <UpdateBroadcastResponse xmlns="http://api.DAgentAPI.com/">
      <UpdateBroadcastResult>xml</UpdateBroadcastResult>
    </UpdateBroadcastResponse>
  </soap12:Body>
</soap12:Envelope>