Outbox-Documentations
  • Documentations
  • API Json Examples
  • Soap XML Documentations
Powered by GitBook
On this page

Was this helpful?

Soap XML Documentations

Outbox Send Message and Status API SOAP Documentation

Send Message XML (Soap)
url: http://soap.outbox.rest 

-------------------------Normal Message-------------------------
<?xml version='1.0' encoding='utf-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:krea="krea.outbox">
    <soapenv:Body>
        <krea:send_message>
            <krea:data>
                <krea:AuthKey>****************</krea:AuthKey>
                <krea:MessageType>SMS/EMAIL/MMS</krea:MessageType>
                <krea:Priority>FAST/NORMAL/TEST</krea:Priority>
                <krea:MessageID>123</krea:MessageID>
                <krea:Recipients>
                    <krea:Subject>Test Subject</krea:Subject>
                    <krea:Content>Test SMS</krea:Content>
                    <krea:Recipient>9053********</krea:Recipient>
                </krea:Recipients>
                <krea:Unique>ON/OFF</krea:Unique>
            </krea:data>
        </krea:send_message>
    </soapenv:Body>
</soapenv:Envelope>

-------------------------Attachment(URL) Message-------------------------
<?xml version='1.0' encoding='utf-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:krea="krea.outbox">
    <soapenv:Body>
        <krea:send_message>
            <krea:data>
                <krea:AuthKey>****************</krea:AuthKey>
                <krea:MessageType>SMS/EMAIL/MMS</krea:MessageType>
                <krea:Priority>FAST/NORMAL/TEST</krea:Priority>
                <krea:MessageID>123</krea:MessageID>
                <krea:Recipients>
                    <krea:Subject>Test Subject</krea:Subject>
                    <krea:Content>Test Message</krea:Content>
                    <krea:Recipient>test@krea.digital</krea:Recipient>
                    <krea:Attachment>https://storage.googleapis.com/krea/assets/img/logo.png</krea:Attachment>
                </krea:Recipients>
            </krea:data>
        </krea:send_message>
    </soapenv:Body>
</soapenv:Envelope>

-------------------------Attachment(Base64) Message-------------------------
<?xml version='1.0' encoding='utf-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:krea="krea.outbox">
    <soapenv:Body>
        <krea:send_message>
            <krea:data>
                <krea:AuthKey>****************</krea:AuthKey>
                <krea:MessageType>SMS/EMAIL/MMS</krea:MessageType>
                <krea:Priority>FAST/NORMAL/TEST</krea:Priority>
                <krea:MessageID>123</krea:MessageID>
                <krea:Recipients>
                    <krea:Subject>Test Subject</krea:Subject>
                    <krea:Content>Test Message</krea:Content>
                    <krea:Recipient>test@krea.digital</krea:Recipient>
                    <krea:BAttachment>iVBORw0KGgoAAAANSUhEUgAAAJYAAAA8CAYAAACEhkNqAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA+VpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMC1jMDYwIDYxLjEzNDc3NywgMjAxMC8wMi8xMi0xNzozMjowMCAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczpkYz0iaHR0cDovL3B1cmwub3JnL2RjL2VsZW1lbnRzLzEuMS8iIHhtbG5zOnhtcE1NPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvbW0vIiB4bWxuczpzdFJlZj0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL3NUeXBlL1Jlc291cmNlUmVmIyIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ1M1IFdpbmRvd3MiIHhtcDpDcmVhdGVEYXRlPSIyMDE2LTExLTMwVDE0OjI2OjIzKzAyOjAwIiB4bXA6TW9kaWZ5RGF0ZT0iMjAxNi0xMi0wMlQxMTo0MDowMiswMjowMCIgeG1wOk1ldGFkYXRhRGF0ZT0iMjAxNi0xMi0wMlQxMTo0MDowMiswMjowMCIgZGM6Zm9ybWF0PSJpbWFnZS9wbmciIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6NEM0RUVERDRCODczMTFFNjlCQjE4RjYzMzY1QjdBQjMiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6NEM0RUVERDVCODczMTFFNjlCQjE4RjYzMzY1QjdBQjMiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDo0QzRFRUREMkI4NzMxMUU2OUJCMThGNjMzNjVCN0FCMyIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDo0QzRFRUREM0I4NzMxMUU2OUJCMThGNjMzNjVCN0FCMyIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PstYaJgAAAleSURBVHja7FwJbBVFGJ6elHLYKgWk2sihqEVLNCqHCBgIKggeqBgtpkQlGhERYwhaUTEI4oUgophgQgqKB0cRAUUI0QBGQSSVeDRISrEgFiytpder/5/3r/yd7L7dffu23bb/n3x5b+bNzs7ufPtfM/viGhsblYhIrCVOiCUixBIRYokIseQuiAixRIRYIkIsEREhlkhrJdbguUXl8PE14EwruIaRgOsBh2Q63cuu/Gxf+k20qD8KuB9OakssIGFL35tCQLJQJFgSb6XJAJ1byTUkAMSetxJiiYgIsUSCJ4luGoM/lQIfDwFSqGod4Df6ngF4gMwomqc/AB/adNkBsAaQqdXXAg4ACgA7ZZraOLFAOgFeAyRR+TAj1mLAPaztOIca8xrA+WY8BjwIeBKwSKaqbZtCdJJPs3I9feZqpJoJ+Nxhn9Xs+37ANsDfbHwLAJfIVLUvH+tfQA9No6wFvB5lf88CRgFuor4NczlCpqp9EQt9qbcA6VT+FfBwDMb1PaCClVNlqtq2j6WbRTR5I6lcTibxhIc+ewEuBkwCdGf1RTJV7YdYcYxUKJgB/87jeJYQYXkmfQtgh0xV+9JYuOTTkcoTyBfyQoIkrbwKMBVQF0VfGMHOp89IUkh+IRdce5zi4CHYy8ppgHnqbCrGSj4DbCQ34gXS0laCEffLgK702dHhta8EbNdcCTy+i9Zuv1nEPXhuUTf4eIk94Ad35WcvbC5iocwBPAbIohtboLwtCC8HXAe4kspZWtToRlKIlEk27Y6bEGsAIM/muC0asTDIeMTBuEqJWPF0jkjE+okIgQ/Hoy6u/YBGrATyfXXSf6XMUznn0L0zZA/AFbG8OO9oCn9Q4VwT95EKPDjbGwDTNc0x24NG5amRBgoIDJxhNz1NM7+VdGylaroOWU/HnmZRaxxplHRqr5+HA4/7RyMZ1tWaRNtYX8bGfoTqsJ8qrX2ddo4KbWzn0thC9Jsx9nrQTmkAXROGWBtlcj7fo0Jk9pdkAv7XpCqcLI1GupEp3cDqZjEN5jXSHMBgjHkqBQe3aykT3E8yTCPnHjo2m552w+Rup3Hj94PaeTjwuPcYScdT3UptrLlUn0tlzOsNojrs516t/cfaOT5iWhs1624iVzG1MfodQdc+Jwg+VrymtVDyVTiDPprKU2jATvJZHUx8rKcBY+g31H4fAIZ6MIuKji1hZUNzdCEkak9oFZEqFKEPoy0uSfVgGrDEoUY1NNIpE3NZomnbUu0BVNq1lFhcM1qRnmy+sd2FjHi9THyvFsljNdBNaWRmIkRkOsTq0De4xaavEPkDRQQjVfEL4EVWn0pEi+W14lg3A36nMj4YuAyVwdok2/SBGm0iTVgtabFtUeYDIwUxdkFOgkkbdCPupIcT5+RbwFZGxC8A+6jcG8zhOECfltJYOKAb2IUcZr+hDzCETUyCZkbMpEY1XVPk2gFN1QKmGRNj/FAVEp6hCGg6YSxgk0MfE4ON/lQ+RtdSE5CIfyngCqYM8tTZdd0ieujHUiBxM2E2KYTmJRaEnDjAn7XQlBfLmHp3owGd/Fbv0wQkuRiPmanhREsJELGqI7gcVhq5rqU0loi9FjPkMtKAjdrv68gEt+TYfBchln/SR8sFKWYyW4JYDS6thRAroFJN0V6yaprXaylT2dUk+uscGGKBT5XqIGoxwnA3fhF/gSOOJqauFRMLo7DLAbeRI92SgoHUWpP72TEwxAJZBrjRQTsMw3e76BfTFc+xsB6TjpOb4abXeLgnXBOhL1Wp9fun8rbbI5bSM+g+FiYCM13edCfaComVxepwRypmhP16EbU3heNGVh/zaSUuo9qtlHIZRhHhXSqcyNwZMHcDSY8vIFdo9bglfFBQiMXNGw60PIIpdCoDTS4wmczIGz7dbOybrwxgzqzAZEIiTdY0uodI/gtUeDfGQTKBQZIQBRLFWj3mrjYFhVhcVqjwyw5m/brxr3KV+SoA1i9STROnsYqKqhxo2GqNXGZRFPopnSL068RZ130fP/7awOz6UqK8d74TC29qhkn9SRdkwIsbz8qY5xlDfeeQNtsbgxuLi69rWLkffa6ler5JETcw4haYDlrklENtcflmJqUOkHx55B68CuirnScrgkO9kDTdQO23V8g3wwX+5QHQeDkQtK3R6sp25Wc/7hex8IbeZ1KP7x6udtjHKJoMlNOkAT8BXEVabLIHYvHryyAfSBfc7Ka//9jfom13Vv88EQs183oK55Eo6RbHKhaYGJ93W/irI5nGXG7hk+okVRHqEthxeL4jFv3Es/pEi+s25C+Ab8RKskg9uHHc+Wtjm8lfWU/EQrlVhbfOuDUPjaQ5o1HzlSaOrm6qdFPfifJWdi4AX2opVZF3FpRH8HMrbPzZCtamgcxtPN3bVeS71mj9nGHtT9qkI0r9NIVHTBxCpZxtGzFCYL4IjX3hqvxxIgY+OX1Iq210OTZcMB+iIu/giFNNN94pZh532JD2mFaHY75WRV464edDckyIMAdxWvqCC0aw2TbtJqmma4HH6IEvJuJg4PG+1s8pRpqrba6l3k9iFZA2iVYwKklj5VkW/eVFQSz08Y5GOa4q5X7XZIPdU2xCzrIox1fLzJmVHLewJPUUEOHO3zzwk5bojaCu3uW1WNr7aCWT8kA6csjnsBOnCdDRqpkTfG1Y4kmToe8WAqd8BiDBj5N4EXTc91lguM2xmJwcysqLqT8DM1gYjn7IHcKJmM/7UvKrpgWBWKmaHxBvgjhlv544hbVBs5NPTqWBN9XZHY4oU5UsmsdcwOy9g+QCrTU9lv1GM1GbTRxXMzlsQ2gkk7Hpf6+FE43h+0TmV6RTmCsSW8EXPKYBufAVs2VANs8Jaas/t8VtocPhBLYLqAH4D1JcknhChf83QiSy4FtV71IwVE0ai88lWhFMCq9w8v+zfkaFIq1cgEzov84nLoQoRbNaeVxWEmK1T0FthTsycMUD3yzCbdTziExvW7glQiwRa9eHyIP5Q0zm4vuJxZR66Afmb5nfUWGj8vZyaHNKSPjiWDB9c6kKr2Sg+ftUhTdt/ojaC8xiX7+jwvMAY+BEp1rBzcpU8j/vTgX/j+EpFX6FD9cJd6jwhgFc58RdJhcp8yW6mBGrkIX5QRdMVZwQzjgSfAC/0epwNwkuSNutj3pPN4iICLFEhFgiQiwRESGWiBBLRIglIhK9/CfAAIwpa6QKBGCfAAAAAElFTkSuQmCC</krea:BAttachment>
                    <krea:BType>png</krea:BType>
                    </krea:Recipients>
            </krea:data>
        </krea:send_message>
    </soapenv:Body>
</soapenv:Envelope>

-------------------------Variables Message-------------------------
<?xml version='1.0' encoding='utf-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:krea="krea.outbox">
    <soapenv:Body>
        <krea:send_message>
            <krea:data>
                <krea:AuthKey>****************</krea:AuthKey>
                <krea:MessageType>SMS/EMAIL/MMS</krea:MessageType>
                <krea:Priority>FAST/NORMAL/TEST</krea:Priority>
                <krea:MessageID>123</krea:MessageID>
                <krea:Recipients>
                    <krea:Subject>Test Subject</krea:Subject>
                    <krea:Content>Test Message</krea:Content>
                    <krea:Variables>
                    	&lt;Content&gt;Test Messag&lt;/Content&gt;
                    </krea:Variables>
                    <krea:Recipient>test@krea.digital</krea:Recipient>
                    </krea:Recipients>
            </krea:data>
        </krea:send_message>
    </soapenv:Body>
</soapenv:Envelope>
-------------------------Normal Message with Reference -------------------------
<?xml version='1.0' encoding='utf-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:krea="krea.outbox">
    <soapenv:Body>
        <krea:send_message>
            <krea:data>
                <krea:AuthKey>****************</krea:AuthKey>
                <krea:MessageType>SMS/EMAIL/MMS</krea:MessageType>
                <krea:Priority>FAST/NORMAL/TEST</krea:Priority>
                <krea:MessageID>123</krea:MessageID>
                <krea:Recipients>
                	<krea:Reference>12345</krea:Reference>
                    <krea:Subject>Test Subject</krea:Subject>
                    <krea:Content>Test Message</krea:Content>
                    <krea:Recipient>test@krea.digital</krea:Recipient>
                    </krea:Recipients>
            </krea:data>
        </krea:send_message>
    </soapenv:Body>
</soapenv:Envelope>

Key

Description

Attachment

Allowed types

  • MMS: 3GP, PDF, CSV, DOC, XLS, TXT, MP3, MP4, ICS

  • EMAIL: PPT

  • IMAGE: JPG, JPEG, GIF, BMP, PNG

Reference

You may use tour own single and unique tracking id you generate for each message, and you may follow delivery results with your won tracking id

Variables

Variables for dynamic contents

Priority

  • NORMAL

  • FAST: Deliver fast, prioritize delivery

  • TEST: Treat message as a tst message and update CDN and source files

Unique

In the same time zone, sending messages to the same person is blocked by the system. You can change it with Unique Key.

BAttachment

Attachment's Base64 (must include BType)

BType

BAttachment File Type (ex. png,jpg,pdf)

Send Message XML (Soap) Response
Response Codes and Response Messages

Response Status Code : 200
    <?xml version='1.0' encoding='UTF-8'?>
    <soap11env:Envelope xmlns:soap11env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="krea.outbox">
        <soap11env:Body>
            <tns:send_messageResponse>
                <tns:send_messageResult>
                    <result type="dict">
                        <message type="list">
                            <item type="dict">
                                <TrackingID type="str">46c8800a37514747a1b5a8a38617f961</TrackingID>
                                <Recipient type="str">test@krea.digital</Recipient>
                            </item>
                        </message>
                        <status type="dict">
                            <Length type="int">1</Length>
                            <Accepted type="int">1</Accepted>
                        </status>
                    </result>
                </tns:send_messageResult>
            </tns:send_messageResponse>
        </soap11env:Body>
    </soap11env:Envelope>
    
Response Status Code : 404
    <?xml version='1.0' encoding='UTF-8'?>
    <soap11env:Envelope xmlns:soap11env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="krea.outbox">
        <soap11env:Body>
            <tns:send_messageResponse>
                <tns:send_messageResult>
                    <result type="dict">
                        <message type="str">Token does not exist</message>
                        <status type="int">404</status>
                    </result>
                </tns:send_messageResult>
            </tns:send_messageResponse>
        </soap11env:Body>
    </soap11env:Envelope>
    
 Response Status Code : 403  
    <?xml version='1.0' encoding='UTF-8'?>
    <soap11env:Envelope xmlns:soap11env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="krea.outbox">
        <soap11env:Body>
            <tns:send_messageResponse>
                <tns:send_messageResult>
                    <result type="dict">
                        <message type="str">Invalid Token</message>
                        <status type="int">403</status>
                    </result>
                </tns:send_messageResult>
            </tns:send_messageResponse>
        </soap11env:Body>
    </soap11env:Envelope>
    
Response Status Code : 403  //Post Payload Not Acceptable
    <?xml version='1.0' encoding='UTF-8'?>
    <soap11env:Envelope xmlns:soap11env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="krea.outbox">
        <soap11env:Body>
            <tns:send_messageResponse>
                <tns:send_messageResult>
                    <result type="dict">
                        <message type="str">Invalid Post Payload</message>
                        <status type="int">403</status>
                    </result>
                </tns:send_messageResult>
            </tns:send_messageResponse>
        </soap11env:Body>
    </soap11env:Envelope>
    
Response Status Code : 500 
    <?xml version='1.0' encoding='UTF-8'?>
    <soap11env:Envelope xmlns:soap11env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="krea.outbox">
        <soap11env:Body>
            <tns:send_messageResponse>
                <tns:send_messageResult>
                    <result type="dict">
                        <message type="str">An error occurred while sending a message</message>
                        <status type="int">500</status>
                    </result>
                </tns:send_messageResult>
            </tns:send_messageResponse>
        </soap11env:Body>
    </soap11env:Envelope>
Get Status XML (Soap)
url: http://soap.outbox.rest

--------------------Request--------------------
<?xml version='1.0' encoding='utf-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:krea="krea.outbox">
    <soapenv:Body>
        <krea:get_status>
            <krea:data>
                <krea:AuthKey>123</krea:AuthKey>
                <krea:Language>TR/EN</krea:Language>
                <krea:TrackingID>176022f32f354d53b9e7a184ab3b3c5e</krea:TrackingID>
                <krea:Type>EMAIL/SMS/MMS (If null, get last sent message)</krea:Type>
            </krea:data>
        </krea:get_status>
    </soapenv:Body>
</soapenv:Envelope>

--------------------Response--------------------
<soap11env:Envelope xmlns:soap11env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="krea.outbox">
    <soap11env:Body>
        <tns:get_statusResponse>
            <tns:get_statusResult>
                <result type="dict">
                    <Code type="int">0</Code>
                    <Recipient type="str">9053********</Recipient>
                    <Status type="str">Başarılı/Success</Status>
                </result>
            </tns:get_statusResult>
        </tns:get_statusResponse>
    </soap11env:Body>
</soap11env:Envelope>
PreviousAPI Json Examples

Last updated 5 years ago

Was this helpful?