openapi: 3.0.0
info:
  title: NETGSM API
  version: 1.0.0
servers:
  - url: https://api.netgsm.com.tr
  - url: http://soap.netgsm.com.tr:8080
tags:
  - name: SMS
  - name: SMS > SMS Gönderimi
  - name: SMS > SMS Gönderimi > XML POST
  - name: SMS > SMS Gönderimi > SOAP Servisi
  - name: SMS > SMS İptali
  - name: SMS > SMS Sorgulama
  - name: SMS > SMS Sorgulama > HTTP POST
  - name: SMS > SMS Sorgulama > SOAP Servisi
  - name: SMS > OTP SMS
  - name: SMS > OTP SMS > XML POST
  - name: SMS > Gelen SMS
  - name: SMS > Gelen SMS > XML POST
  - name: SMS > Gelen SMS > SOAP Servisi
  - name: SMS > Gönderici Adı Sorgulama
  - name: SMS > Gönderici Adı Sorgulama > SOAP Servisi
  - name: SMS > Kara Liste
  - name: NETIYS
  - name: NETIYS > İYS Adres Yükleme
  - name: NETIYS > İYS Adres Sorgulama
  - name: SABİT TELEFON
  - name: SABİT TELEFON > Görüşme Detayı
  - name: SABİT TELEFON > Telesekreter Mesajları
  - name: SESLİ MESAJ
  - name: SESLİ MESAJ > Sesli Mesaj Başlarma
  - name: SESLİ MESAJ > Sesli Mesaj Başlarma > Basit Sesli Mesaj
  - name: SESLİ MESAJ > Sesli Mesaj Başlarma > Dinamik Sesli Mesaj
  - name: SESLİ MESAJ > Raporlama Servisi
  - name: SESLİ MESAJ > Raporlama Servisi > Sesli Mesaj Raporlar
  - name: FAKS
  - name: FAKS > Dosya Yükleme
  - name: FAKS > Faks Gönderme
  - name: FAKS > Gelen Faks
  - name: FAKS > Raporlama
  - name: HESAP APILERİ
  - name: HESAP APILERİ > Kredi & Paket Sorgulama
  - name: HESAP APILERİ > Kredi & Paket Sorgulama > XML POST
  - name: HESAP APILERİ > Kredi & Paket Sorgulama > SOAP Servisi
  - name: HESAP APILERİ > Kredi & Paket Sorgulama > JSON POST
paths:
  /sms/send/xml:
    post:
      tags:
        - SMS > SMS Gönderimi > XML POST
      summary: İleri tarihli gönderim
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n <mainbody>\r\n
                <header>\r\n <company dil=\"TR\">Netgsm</company>\r\n
                <usercode>kullanıcıadı</usercode>\r\n
                <password>şifre</password>\r\n <type>1:n</type>\r\n
                <msgheader>mesajbaşlığı</msgheader>\r\n
                <startdate>230520221300</startdate>\r\n
                <stopdate>230520221900</stopdate>\r\n <appkey>xxx</appkey> \r\n
                </header>\r\n <body>\r\n <msg>\r\n <![CDATA[Mesaj Metnim]]>\r\n
                </msg>\r\n <no>5XXXXXXXXX</no>\r\n </body>\r\n </mainbody>"
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /Sms_webservis/SMS:
    post:
      tags:
        - HESAP APILERİ > Kredi & Paket Sorgulama > SOAP Servisi
      summary: SOAP Servisi ile Paket/Kampanya Sorgulama Copy
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "<?xml version=\"1.0\"?>\r\n<SOAP-ENV:Envelope
                xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\"\r\n            
                xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\r\n 
                xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\r\n   
                <SOAP-ENV:Body>\r\n        <ns3:paketkampanya
                xmlns:ns3=\"http://sms/\">\r\n           
                <username>312XXXXXXX</username>\r\n           
                <password>XXXXX</password>\r\n            <appkey>xxx</appkey>
                \r\n        </ns3:paketkampanya>\r\n   
                </SOAP-ENV:Body>\r\n</SOAP-ENV:Envelope>"
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: text/xml
        - name: wsdl
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /sms/edit:
    post:
      tags:
        - SMS > SMS İptali
      summary: İleri tarihli SMS iptali
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "<?xml version='1.0' encoding='UTF-8'?>\r\n<mainbody>\r\n  
                <header>\r\n       <usercode>kullanıcıadı</usercode>\r\n      
                <password>şifre</password>\r\n      
                <gorevid>görevid</gorevid>\r\n       <type>0</type>\r\n      
                <appkey>xxx</appkey> \r\n   </header>\r\n</mainbody>"
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /sms/report:
    post:
      tags:
        - SMS > SMS Sorgulama > HTTP POST
      summary: HTTP POST Rapor
      requestBody:
        content: {}
      parameters:
        - name: usercode
          in: query
          schema:
            type: string
          description: Abone numaranız
          example: kullanicidiniz
        - name: password
          in: query
          schema:
            type: string
          description: Kullanıcı şifreniz
          example: sifreniz
        - name: bulkid
          in: query
          schema:
            type: integer
          description: Görev id
          example: '748372846'
        - name: type
          in: query
          schema:
            type: integer
          description: Sorgulama tipi
          example: '0'
        - name: status
          in: query
          schema:
            type: integer
          description: Sorgulama yapılacak mesaj durumu
          example: '100'
        - name: version
          in: query
          schema:
            type: integer
          example: '2'
        - name: appkey
          in: query
          schema:
            type: string
          example: xxxx
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /sms/send/otp:
    post:
      tags:
        - SMS > OTP SMS > XML POST
      summary: XML POST OTP SMS
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "<?xml version=\"1.0\"?>\r\n<mainbody>\r\n   <header>\r\n      
                <usercode>kullanıcıadı</usercode>\r\n      
                <password>şifre</password>\r\n      
                <msgheader>mesajbaşlığı</msgheader>\r\n      
                <appkey>xxx</appkey> \r\n   </header>\r\n   <body>\r\n      
                <msg>\r\n           <![CDATA[TestMesajı]]>\r\n      
                </msg>\r\n       <no>5XXXXXXXXX</no>\r\n  
                </body>\r\n</mainbody>"
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /sms/receive:
    post:
      tags:
        - SMS > Gelen SMS > XML POST
      summary: XML POST Gelen SMS
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "<?xml version='1.0' encoding='UTF-8'?>\r\n<mainbody>\r\n  
                <header>\r\n       <usercode>kullanıcıadı</usercode>\r\n      
                <password>şifre</password>\r\n      
                <startdate>230520220800</startdate>\r\n      
                <stopdate>230520220947</stopdate>\r\n      
                <type>0</type>\r\n       <appkey>xxx</appkey> \r\n  
                </header>\r\n</mainbody>"
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /sms/blacklist:
    post:
      tags:
        - SMS > Kara Liste
      summary: XML POST Kara Liste
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "<?xml version=\"1.0\"?>\r\n<mainbody>\r\n  <header>  \r\n   
                <usercode>kullaniciadiniz</usercode>\r\n   
                <password>sifreniz</password>\r\n    <tip>1</tip>\r\n   
                <appkey>xxx</appkey> \r\n  </header>\r\n  <body>\r\n   
                <number>05*********</number>\r\n  </body>\r\n</mainbody>"
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /iys/add:
    post:
      tags:
        - NETIYS > İYS Adres Yükleme
      summary: JSON POST ile Adres Ekle
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                header:
                  username: kullaniciadi
                  password: sifre
                  brandCode: markakodu
                  appkey: xxx
                body:
                  data:
                    - type: EPOSTA
                      source: HS_WEB
                      recipient: '****'
                      status: ONAY
                      consentDate: '2021-07-29 09:40:00'
                      recipientType: BIREYSEL
                    - type: MESAJ
                      source: HS_MESAJ
                      recipient: +905*********
                      status: ONAY
                      consentDate: '2021-07-29 09:40:00'
                      recipientType: BIREYSEL
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /iys/search:
    post:
      tags:
        - NETIYS > İYS Adres Sorgulama
      summary: JSON POST ile Adres Sorgula
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                header:
                  username: kullaniciadi
                  password: sifre
                  brandCode: markakodu
                  appkey: xxxx
                body:
                  data:
                    - type: MESAJ
                      recipient: +905*********
                      recipientType: BIREYSEL
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /voice/report:
    post:
      tags:
        - SABİT TELEFON > Görüşme Detayı
      summary: XML POST Görüşme Detayı
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "<?xml version='1.0' encoding='UTF-8'?>\r\n<mainbody>\r\n  
                <header>\r\n      
                <usercode>kullaniciadiniz</usercode>\r\n      
                <password>sifreniz</password>\r\n      
                <date>100520211000</date>\r\n      
                <direction>1</direction>\r\n       <appkey>xxx</appkey>      
                \r\n   </header>\r\n</mainbody>"
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /voicesms/receive:
    post:
      tags:
        - SABİT TELEFON > Telesekreter Mesajları
      summary: XML POST Telesekreter Mesajları
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "<?xml version='1.0'?>\r\n     <mainbody>\r\n       <header> 
                \r\n         <usercode>kullaniciadiniz</usercode>\r\n        
                <password>sifreniz</password>\r\n        
                <startdate>080520210000</startdate>\r\n        
                <stopdate>090520210000</stopdate>\r\n        
                <appkey>xxx</appkey> \r\n       </header>\r\n     </mainbody>"
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /voicesms/send:
    post:
      tags:
        - SESLİ MESAJ > Sesli Mesaj Başlarma > Dinamik Sesli Mesaj
      summary: JSON POST Sesli mesaj
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                header:
                  username: 312XXXXXXXX
                  password: XXXXX
                  key: '1'
                  url: ''
                  appkey: xxxx
                body:
                  scenario:
                    series:
                      - seri: '1'
                        text: test mesajı
                    numbers:
                      - 'no': 5XXXXXXXXX
                    keys:
                      - keyinfo: '1'
                        text: 'test bir '
                      - keyinfo: '2'
                        text: test iki
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /voicesms/report:
    post:
      tags:
        - SESLİ MESAJ > Raporlama Servisi > Sesli Mesaj Raporlar
      summary: HTTP POST Sesli Mesaj Rapor
      requestBody:
        content: {}
      parameters:
        - name: usercode
          in: query
          schema:
            type: string
          example: kullaniciadi
        - name: password
          in: query
          schema:
            type: string
          example: sifre
        - name: bulkid
          in: query
          schema:
            type: integer
          example: '27221105'
        - name: type
          in: query
          schema:
            type: integer
          example: '0'
        - name: status
          in: query
          schema:
            type: integer
          example: '0'
        - name: tus
          in: query
          schema:
            type: integer
          example: '1'
        - name: appkey
          in: query
          schema:
            type: string
          example: xxxxx
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /fax/send:
    post:
      tags:
        - FAKS > Faks Gönderme
      summary: Form Data Faks Gönderme
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                username:
                  type: string
                  example: kullaniiciadi
                password:
                  type: string
                  example: sifre
                refid:
                  type: integer
                  example: '123456'
                telefon:
                  type: string
                  example: 85********
                parametre:
                  type: integer
                  example: '2'
                appkey:
                  type: string
                  example: xxx
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /fax/receive:
    post:
      tags:
        - FAKS > Gelen Faks
      summary: XML POST Gelen Fax
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "<?xml
                version=\"1.0\"?>\r\n<mainbody>\r\n\t<header>\r\n\t\t<company>Netgsm</company>\r\n\t\t<usercode>kullaniciadi</usercode>\r\n\t\t<password>sifre</password>\r\n\t\t<startdate>150320210101</startdate>\r\n\t\t<stopdate>100420210101</stopdate>\r\n\t\t<type>1</type>\r\n       
                <appkey>xxx</appkey> \r\n\t</header>\r\n</mainbody>"
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /fax/report:
    post:
      tags:
        - FAKS > Raporlama
      summary: HTTP POST Raporlama
      requestBody:
        content: {}
      parameters:
        - name: usercode
          in: query
          schema:
            type: string
          example: kullaniciadi
        - name: password
          in: query
          schema:
            type: string
          example: sifre
        - name: bulkid
          in: query
          schema:
            type: integer
          example: '1434555'
        - name: type
          in: query
          schema:
            type: integer
          example: '0'
        - name: status
          in: query
          schema:
            type: integer
          example: '1'
        - name: appkey
          in: query
          schema:
            type: string
          example: xxxx
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /balance/list/xml:
    post:
      tags:
        - HESAP APILERİ > Kredi & Paket Sorgulama > XML POST
      summary: XML POST Kredi & Paket
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "<?xml
                version=\"1.0\"?>\r\n<mainbody>\r\n\t<header>\t\t\r\n       
                <usercode>abone_numarasi</usercode>\r\n       
                <password>alt_kullanici_sifresi</password>\r\n\t   
                <stip>2</stip>\r\n        <view>1</view> \r\n       
                <appkey>xxx</appkey> \r\n        </header>\t\t\r\n</mainbody>"
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /balance:
    post:
      tags:
        - HESAP APILERİ > Kredi & Paket Sorgulama > JSON POST
      summary: JSON POST Kredi /& Paket
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                usercode: abone_numarasi
                password: alt_kullanici_sifresi
                stip: 2
                appkey: xxx
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
