https://www.toplusmsapi.com/en/assets/js/34bd05b6.a519e08c.js

1"use strict";(self.webpackChunkemarka_apidocs=self.webpackChunkemarka_apidocs||[]).push([[4397],{7957:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>h,contentTitle:()=>l,default:()=>m,frontMatter:()=>d,metadata:()=>n,toc:()=>c});const n=JSON.parse('{"id":"sms/send/get","title":"Get API","description":"If you want to perform the SMS sending operation using the GET method of the HTTP protocol, you can follow the guidelines below. You can generally integrate the SMS integration panels of ready-made software or hardware/devices like firewalls into \u0130leti Merkezi using this documentation.","source":"@site/i18n/en/docusaurus-plugin-content-docs/current/sms/send/get.mdx","sourceDirName":"sms/send","slug":"/sms/gonder/get/","permalink":"/en/sms/gonder/get/","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":0,"frontMatter":{"slug":"/sms/gonder/get/","sidebar_label":"GET","sidebar_position":0},"sidebar":"tutorialSidebar","previous":{"title":"Intro","permalink":"/en/"},"next":{"title":"XML","permalink":"/en/sms/gonder/xml/"}}');var i=t(4848),r=t(8453),a=(t(4865),t(9365),t(5579)),o=t(9844);const d={slug:"/sms/gonder/get/",sidebar_label:"GET",sidebar_position:0},l="Get API",h={},c=[{value:"Request URL",id:"request-url",level:2},{value:"Request Parameters",id:"request-parameters",level:2},{value:"Definitions",id:"definitions",level:3},{value:"Sample Request",id:"sample-request",level:2},{value:"Server Response",id:"server-response",level:2},{value:"Definitions",id:"definitions-1",level:3},{value:"status",id:"status",level:4},{value:"order",id:"order",level:4},{value:"Error Codes",id:"error-codes",level:2},{value:"Sample Successful Response",id:"sample-successful-response",level:2},{value:"Sample Error Response",id:"sample-error-response",level:2}];function u(e){const s={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"get-api",children:"Get API"})}),"\n",(0,i.jsx)(s.p,{children:"If you want to perform the SMS sending operation using the GET method of the HTTP protocol, you can follow the guidelines below. You can generally integrate the SMS integration panels of ready-made software or hardware/devices like firewalls into \u0130leti Merkezi using this documentation."}),"\n",(0,i.jsx)(s.h2,{id:"request-url",children:"Request URL"}),"\n",(0,i.jsx)(o.A,{type:"GET",url:"https://api.iletimerkezi.com/v1/send-sms/get/"}),"\n",(0,i.jsx)(s.h2,{id:"request-parameters",children:"Request Parameters"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-bash",children:"https://api.iletimerkezi.com/v1/send-sms/get/?key=API_KEY&hash=API_HASH&text=Lorem%20ipsum%20dolor%20sit%20amet&receipents=5301234569,5301234570&sender=APITEST&iys=1&iysList=BIREYSEL\n"})}),"\n",(0,i.jsx)(s.admonition,{title:"Tip",type:"tip",children:(0,i.jsx)(s.p,{children:"After writing your values to the request parameters, you can try the integration by entering the generated URL in your browser's address bar. If you encounter an error, you can check how to resolve it in the status and error codes section."})}),"\n",(0,i.jsx)(s.h3,{id:"definitions",children:"Definitions"}),"\n",(0,i.jsx)(s.p,{children:"The explanations of the parameters sent in the request are as follows:"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"key:"}),"\nThis should be the API Key that you can create from the settings section after logging into your iletimerkezi.com panel. It is mandatory to send this when making the request."]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"hash:"}),"\nThis should be the hash created using the API Key and Secret Key that you can create from the settings section after logging into your iletimerkezi.com panel. It is mandatory to send this when making the request."]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"text:"}),"\nThis contains the SMS text to be sent. It is mandatory to send this when making the request. It must be URL encoded."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.admonition,{title:"Tip",type:"tip",children:[(0,i.jsx)(s.p,{children:'If you are not integrating into a ready-made panel or if you are creating a panel for SMS integration in your own software, you should encode the values in the "text" field since your message text may contain characters that could break the URL structure.'}),(0,i.jsx)(s.p,{children:"There are built-in functions available in every programming language that perform this encoding."}),(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-bash",children:"&text=Sample unencoded message text\n\n# After encoding, the message text should appear as follows\n&text=Sample%20encoded%20message%20text\n"})}),(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://tr-tr.facebook.com/business/help/474659792899595",children:"For more detailed information"})})]}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"receipents:"}),"\nThis contains the recipient's phone number. The number format should be 5xxxxxxxxx. If you want to define multiple recipients for the specified message text, the numbers should be separated by commas. It is mandatory to send this when making the request."]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"sender:"}),"\nThis is the title defined and approved by iletimerkezi.com from the management panel, consisting of a maximum of 11 characters. The sent message will be sent to the recipient with the title specified by this parameter. It is mandatory to send this when making the request. It must be URL encoded."]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"iys:"}),"\nThis indicates whether the message will be queried through the \u0130leti Y\xf6netim Sistemi (IYS). If you send this value as 1 (true), your messages will be queried through IYS; if you send it as 0 (false), they will not be queried. It is mandatory to send this when making the request."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.admonition,{title:"Tip",type:"tip",children:[(0,i.jsxs)(s.p,{children:["If you are sending a commercial message, this value must be legally set to 1. ",(0,i.jsx)(s.strong,{children:"Otherwise, legal action may be taken"}),"."]}),(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://www.iletimerkezi.com/blog/duyurular/iys-ileti-yonetim-sistemi-nedir",children:"Click for detailed information about IYS."})})]}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.strong,{children:"iysList:"}),"\nThis indicates the list you want to query through the \u0130leti Y\xf6netim Sistemi (IYS). If you sent the value of iys as 1, meaning you want your message to be queried through IYS, the iysList value must be sent as either BIREYSEL or TACIR. If you send the value of iys as 0, this field will not be considered."]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"sample-request",children:"Sample Request"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-bash",children:"https://api.iletimerkezi.com/v1/send-sms/get/?key=3ea65b1e8baxxxx&hash=XXXX&text=Lorem%20ipsum%20dolor%20sit%20amet&receipents=5301234569,5301234570&sender=APITEST&iys=1&iysList=BIREYSEL\n"})}),"\n",(0,i.jsx)(s.h2,{id:"server-response",children:"Server Response"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-xml",children:"<response>\n  <status>\n    <code></code>\n    <message></message>\n  </status>\n  <order>\n    <id></id>\n  </order>\n</response>\n"})}),"\n",(0,i.jsx)(s.h3,{id:"definitions-1",children:"Definitions"}),"\n",(0,i.jsxs)(s.p,{children:["The response from the server is always encapsulated with the ",(0,i.jsx)(a.A,{children:"response"})," tag. The definitions of its sub-tags are as follows:"]}),"\n",(0,i.jsx)(s.h4,{id:"status",children:"status"}),"\n",(0,i.jsx)(s.p,{children:"Contains information about the transaction status. The values returned with this tag can also be obtained by looking at the header information of the HTTP response. This tag is returned as a standard in every request made. Its sub-tags are as follows:"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.strong,{children:"code:"})," This is a numeric value indicating the transaction status."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.strong,{children:"message:"})," This contains an informational message about the transaction status."]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"order",children:"order"}),"\n",(0,i.jsxs)(s.p,{children:["Contains the order information created if the transaction is successfully completed. This tag is not returned if the transaction fails. The ",(0,i.jsx)(a.A,{children:"order"}

1)," tag is not repeatable. Only one order can be sent per request. Its sub-tag is as follows:"]}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.strong,{children:"id:"}),' This is a unique numeric value representing the order. You can save the "id" value in your systems and use it when querying the report of the order or canceling the order if you have made a future date delivery.']}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"error-codes",children:"Error Codes"}),"\n",(0,i.jsx)(s.p,{children:"If the result of the request is negative, the error codes and messages that the server will return to you are as follows."}),"\n",(0,i.jsxs)("table",{children:[(0,i.jsx)("thead",{children:(0,i.jsxs)("tr",{children:[(0,i.jsx)("th",{children:"code"}),(0,i.jsx)("th",{children:"message"}),(0,i.jsx)("th",{children:"Description"})]})}),(0,i.jsxs)("tbody",{children:[(0,i.jsxs)("tr",{children:[(0,i.jsx)("td",{children:"401"}),(0,i.jsx)("td",{children:"Membership information is incorrect"}),(0,i.jsxs)("td",{children:["This error is returned if the information you sent within the ",(0,i.jsx)(a.A,{children:"key"}),", ",(0,i.jsx)(a.A,{children:"hash"})," tags could not be validated. If you have defined a static IP in your account and you make the request from a different IP, you will receive this error as well."]})]}),(0,i.jsxs)("tr",{children:[(0,i.jsx)("td",{children:"402"}),(0,i.jsx)("td",{children:"Insufficient balance"}),(0,i.jsx)("td",{children:"This error is returned if the balance in your account is not enough to send this order."})]}),(0,i.jsxs)("tr",{children:[(0,i.jsx)("td",{children:"450"}),(0,i.jsx)("td",{children:"The sent title is not suitable for use"}),(0,i.jsxs)("td",{children:["This error is returned if the value you sent with the ",(0,i.jsx)(a.A,{children:"sender"})," tag is not approved in your account. You must send it as defined in your account. Generally, changes that cause this error are differences in case sensitivity or sending extra space values."]})]}),(0,i.jsxs)("tr",{children:[(0,i.jsx)("td",{children:"451"}),(0,i.jsx)("td",{children:"Repeated order"}),(0,i.jsx)("td",{children:"If you try to send the same message text to the same recipients within 10 minutes, the system will return this error to you to prevent spam and ensure that the same messages are not sent to the same people by mistake. If you have such a sending requirement, you can differentiate the message text by writing the current time and minute in the message text."})]}),(0,i.jsxs)("tr",{children:[(0,i.jsx)("td",{children:"452"}),(0,i.jsx)("td",{children:"Message recipients are incorrect"}),(0,i.jsxs)("td",{children:["This error is returned if the phone numbers you sent with the ",(0,i.jsx)(a.A,{children:"receipents"})," tag are incomplete or cannot be verified. Also, if you are sure that the mobile phone number you want to send a message to is correct, you may receive this error if the mobile phone number has been added to your block list."]})]}),(0,i.jsxs)("tr",{children:[(0,i.jsx)("td",{children:"453"}),(0,i.jsx)("td",{children:"Order size exceeded"}),(0,i.jsxs)("td",{children:["This error returns if the message text you sent with the ",(0,i.jsx)(a.A,{children:"text"})," tag is longer than seven (7) SMS lengths according to your character encoding."]})]}),(0,i.jsxs)("tr",{children:[(0,i.jsx)("td",{children:"454"}),(0,i.jsx)("td",{children:"Message text is empty"}),(0,i.jsxs)("td",{children:["This error returns if the message text you sent in the ",(0,i.jsx)(a.A,{children:"text"})," parameter does not contain any values."]})]})]})]}),"\n",(0,i.jsx)(s.h2,{id:"sample-successful-response",children:"Sample Successful Response"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-xml",children:'<?xml version="1.0" encoding="UTF-8"?>\n<response>\n  <status>\n    <code>200</code>\n    <message>Operation Successful</message>\n  </status>\n  <order>\n    <id>323223</id>\n  </order>\n</response>\n'})}),"\n",(0,i.jsx)(s.h2,{id:"sample-error-response",children:"Sample Error Response"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-xml",children:'<?xml version="1.0" encoding="UTF-8"?>\n<response>\n  <status>\n    <code>401</code>\n    <message>Membership information is incorrect</message>\n  </status>\n</response>\n'})})]})}function m(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}}}]);