Send SMS with XML — for legacy and XML-centric stacks.

When to use XML

Pick the XML API when any of the following applies to your environment.

• Your middleware (Mule, BizTalk, WSO2, legacy ESB) already speaks XML end-to-end.
• You need a schema-validated payload format for downstream audit or compliance.
• You consume responses inside an application that parses XML natively — e.g. Oracle Forms, SAP PI/PO, or an on-prem Java EE stack.
• You want to send several numbers in one request without constructing a JSON array.

Authentication

Authentication uses the same API key as the HTTP API. Place it inside a <credentials> block at the top of every request. Keys are 32-character hex strings and can be generated from Settings → API & Webhooks.

Send SMS

Submit a DLT-compliant message to one or more recipients in a single request. The response contains a messageid you use to fetch delivery reports later.

Request body

Request example

<?xml version="1.0" encoding="UTF-8"?>
<smslocal>
  <credentials>
    <key>YOUR_API_KEY</key>
  </credentials>
  <request>
    <route>1</route>              <!-- 1=transactional, 2=promotional -->
    <sender>ALERTS</sender>
    <templateid>1207161234567890123</templateid>
    <numbers>
      <number>9876543210</number>
      <number>9123456789</number>
    </numbers>
    <sms><![CDATA[Your OTP is 482913. Valid for 10 minutes.]]></sms>
  </request>
</smslocal>

Response

<?xml version="1.0" encoding="UTF-8"?>
<smslocal>
  <response>
    <status>success</status>
    <messageid>1987654321</messageid>
    <count>2</count>
  </response>
</smslocal>

<?xml version="1.0" encoding="UTF-8"?>
<smslocal>
  <response>
    <status>error</status>
    <code>110</code>
    <message>Invalid DLT Template ID</message>
  </response>
</smslocal>

Delivery report

Fetch per-recipient delivery status for a previously-sent batch using its messageid. For high-volume applications, configure a webhook on the dashboard and let us push reports to you instead.

Request body

Request example

<?xml version="1.0" encoding="UTF-8"?>
<smslocal>
  <credentials>
    <key>YOUR_API_KEY</key>
  </credentials>
  <request>
    <messageid>1987654321</messageid>
  </request>
</smslocal>

Response

<?xml version="1.0" encoding="UTF-8"?>
<smslocal>
  <response>
    <status>success</status>
    <reports>
      <report>
        <number>9876543210</number>
        <status>DELIVERED</status>
        <time>2026-04-20 14:21:08</time>
      </report>
      <report>
        <number>9123456789</number>
        <status>FAILED</status>
        <time>2026-04-20 14:21:12</time>
      </report>
    </reports>
  </response>
</smslocal>

Check credits

Retrieve your current balance for a specific route. Poll this before large campaigns or wire it into an internal monitoring dashboard so you top up before running out.

Request body

Request example

<?xml version="1.0" encoding="UTF-8"?>
<smslocal>
  <credentials>
    <key>YOUR_API_KEY</key>
  </credentials>
  <request>
    <route>1</route>
  </request>
</smslocal>

Response

<?xml version="1.0" encoding="UTF-8"?>
<smslocal>
  <response>
    <status>success</status>
    <route>Transactional</route>
    <credits>48215</credits>
  </response>
</smslocal>

Error codes

Error codes are shared between the HTTP and XML APIs. When a request fails, the response will have <status>error</status> and a numeric code.

See the HTTP API reference for full error-code fixes and remediation tips — they apply identically to the XML API.

Migration to REST

Teams that migrate from XML to REST typically save 30–50% on integration code and gain access to newer features like idempotency keys, streaming delivery reports, and native SDK support. Here is the quick mapping: