info:
  description: '# Sms Portable Api

    API slouží k identifikaci skutečného mobilního operátora na základě telefonního
    čísla.


    ## Označení operátorů


    | *Označení* | *Země*              | *Operátor*     |

    | ---------- | ------------------- | -------------- |

    | o2_cz      | Česká Republika     | O2             |

    | tm_cz      | Česká Republika     | T-Mobile       |

    | vf_cz      | Česká Republika     | Vodafone       |

    | nt_cz      | Česká Republika     | Nordic Telecom |

    | fix_cz     | Česká Republika     | Pevná síť      |

    | tm_sk      | Slovenská Republika | T-Mobile       |

    | or_sk      | Slovenská Republika | Orange         |

    | o2_sk      | Slovenská Republika | O2             |

    | sw_sk      | Slovenská Republika | 4ka            |


    ## Označení zemí


    | *Označení* | *Název*                                                    |

    | ---------- | ---------------------------------------------------------- |

    | af         | Afghanistan                                                |

    | al         | Albania                                                    |

    | dz         | Algeria                                                    |

    | as         | American Samoa                                             |

    | ad         | Andorra                                                    |

    | ao         | Angola                                                     |

    | ai         | Anguilla                                                   |

    | aq         | Antarctica                                                 |

    | ag         | Antigua and Barbuda                                        |

    | ar         | Argentina                                                  |

    | am         | Armenia                                                    |

    | aw         | Aruba                                                      |

    | au         | Australia                                                  |

    | at         | Austria                                                    |

    | az         | Azerbaijan                                                 |

    | bs         | Bahamas (the)                                              |

    | bh         | Bahrain                                                    |

    | bd         | Bangladesh                                                 |

    | bb         | Barbados                                                   |

    | by         | Belarus                                                    |

    | be         | Belgium                                                    |

    | bz         | Belize                                                     |

    | bj         | Benin                                                      |

    | bm         | Bermuda                                                    |

    | bt         | Bhutan                                                     |

    | bo         | Bolivia (Plurinational State of)                           |

    | bq         | Bonaire, Sint Eustatius and Saba                           |

    | ba         | Bosnia and Herzegovina                                     |

    | bw         | Botswana                                                   |

    | bv         | Bouvet Island                                              |

    | br         | Brazil                                                     |

    | io         | British Indian Ocean Territory (the)                       |

    | bn         | Brunei Darussalam                                          |

    | bg         | Bulgaria                                                   |

    | bf         | Burkina Faso                                               |

    | bi         | Burundi                                                    |

    | cv         | Cabo Verde                                                 |

    | kh         | Cambodia                                                   |

    | cm         | Cameroon                                                   |

    | ca         | Canada                                                     |

    | ky         | Cayman Islands (the)                                       |

    | cf         | Central African Republic (the)                             |

    | td         | Chad                                                       |

    | cl         | Chile                                                      |

    | cn         | China                                                      |

    | cx         | Christmas Island                                           |

    | cc         | Cocos (Keeling) Islands (the)                              |

    | co         | Colombia                                                   |

    | km         | Comoros (the)                                              |

    | cd         | Congo (the Democratic Republic of the)                     |

    | cg         | Congo (the)                                                |

    | ck         | Cook Islands (the)                                         |

    | cr         | Costa Rica                                                 |

    | hr         | Croatia                                                    |

    | cu         | Cuba                                                       |

    | cw         | Curaçao                                                    |

    | cy         | Cyprus                                                     |

    | cz         | Czechia                                                    |

    | ci         | Côte d''Ivoire                                              |

    | dk         | Denmark                                                    |

    | dj         | Djibouti                                                   |

    | dm         | Dominica                                                   |

    | do         | Dominican Republic (the)                                   |

    | ec         | Ecuador                                                    |

    | eg         | Egypt                                                      |

    | sv         | El Salvador                                                |

    | gq         | Equatorial Guinea                                          |

    | er         | Eritrea                                                    |

    | ee         | Estonia                                                    |

    | sz         | Eswatini                                                   |

    | et         | Ethiopia                                                   |

    | fk         | Falkland Islands (the) [Malvinas]                          |

    | fo         | Faroe Islands (the)                                        |

    | fj         | Fiji                                                       |

    | fi         | Finland                                                    |

    | fr         | France                                                     |

    | gf         | French Guiana                                              |

    | pf         | French Polynesia                                           |

    | tf         | French Southern Territories (the)                          |

    | ga         | Gabon                                                      |

    | gm         | Gambia (the)                                               |

    | ge         | Georgia                                                    |

    | de         | Germany                                                    |

    | gh         | Ghana                                                      |

    | gi         | Gibraltar                                                  |

    | gr         | Greece                                                     |

    | gl         | Greenland                                                  |

    | gd         | Grenada                                                    |

    | gp         | Guadeloupe                                                 |

    | gu         | Guam                                                       |

    | gt         | Guatemala                                                  |

    | gg         | Guernsey                                                   |

    | gn         | Guinea                                                     |

    | gw         | Guinea-Bissau                                              |

    | gy         | Guyana                                                     |

    | ht         | Haiti                                                      |

    | hm         | Heard Island and McDonald Islands                          |

    | va         | Holy See (the)                                             |

    | hn         | Honduras                                                   |

    | hk         | Hong Kong                                                  |

    | hu         | Hungary                                                    |

    | is         | Iceland                                                    |

    | in         | India                                                      |

    | id         | Indonesia                                                  |

    | ir         | Iran (Islamic Republic of)                                 |

    | iq         | Iraq                                                       |

    | ie         | Ireland                                                    |

    | im         | Isle of Man                                                |

    | il         | Israel                                                     |

    | it         | Italy                                                      |

    | jm         | Jamaica                                                    |

    | jp         | Japan                                                      |

    | je         | Jersey                                                     |

    | jo         | Jordan                                                     |

    | kz         | Kazakhstan                                                 |

    | ke         | Kenya                                                      |

    | ki         | Kiribati                                                   |

    | kp         | Korea (the Democratic People''s Republic of)                |

    | kr         | Korea (the Republic of)                                    |

    | kw         | Kuwait                                                     |

    | kg         | Kyrgyzstan                                                 |

    | la         | Lao People''s Democratic Republic (the)                     |

    | lv         | Latvia                                                     |

    | lb         | Lebanon                                                    |

    | ls         | Lesotho                                                    |

    | lr         | Liberia                                                    |

    | ly         | Libya                                                      |

    | li         | Liechtenstein                                              |

    | lt         | Lithuania                                                  |

    | lu         | Luxembourg                                                 |

    | mo         | Macao                                                      |

    | mg         | Madagascar                                                 |

    | mw         | Malawi                                                     |

    | my         | Malaysia                                                   |

    | mv         | Maldives                                                   |

    | ml         | Mali                                                       |

    | mt         | Malta                                                      |

    | mh         | Marshall Islands (the)                                     |

    | mq         | Martinique                                                 |

    | mr         | Mauritania                                                 |

    | mu         | Mauritius                                                  |

    | yt         | Mayotte                                                    |

    | mx         | Mexico                                                     |

    | fm         | Micronesia (Federated States of)                           |

    | md         | Moldova (the Republic of)                                  |

    | mc         | Monaco                                                     |

    | mn         | Mongolia                                                   |

    | me         | Montenegro                                                 |

    | ms         | Montserrat                                                 |

    | ma         | Morocco                                                    |

    | mz         | Mozambique                                                 |

    | mm         | Myanmar                                                    |

    | na         | Namibia                                                    |

    | nr         | Nauru                                                      |

    | np         | Nepal                                                      |

    | nl         | Netherlands (the)                                          |

    | nc         | New Caledonia                                              |

    | nz         | New Zealand                                                |

    | ni         | Nicaragua                                                  |

    | ne         | Niger (the)                                                |

    | ng         | Nigeria                                                    |

    | nu         | Niue                                                       |

    | nf         | Norfolk Island                                             |

    | mp         | Northern Mariana Islands (the)                             |

    | no         | Norway                                                     |

    | om         | Oman                                                       |

    | pk         | Pakistan                                                   |

    | pw         | Palau                                                      |

    | ps         | Palestine, State of                                        |

    | pa         | Panama                                                     |

    | pg         | Papua New Guinea                                           |

    | py         | Paraguay                                                   |

    | pe         | Peru                                                       |

    | ph         | Philippines (the)                                          |

    | pn         | Pitcairn                                                   |

    | pl         | Poland                                                     |

    | pt         | Portugal                                                   |

    | pr         | Puerto Rico                                                |

    | qa         | Qatar                                                      |

    | mk         | Republic of North Macedonia                                |

    | ro         | Romania                                                    |

    | ru         | Russian Federation (the)                                   |

    | rw         | Rwanda                                                     |

    | re         | Réunion                                                    |

    | bl         | Saint Barthélemy                                           |

    | sh         | Saint Helena, Ascension and Tristan da Cunha               |

    | kn         | Saint Kitts and Nevis                                      |

    | lc         | Saint Lucia                                                |

    | mf         | Saint Martin (French part)                                 |

    | pm         | Saint Pierre and Miquelon                                  |

    | vc         | Saint Vincent and the Grenadines                           |

    | ws         | Samoa                                                      |

    | sm         | San Marino                                                 |

    | st         | Sao Tome and Principe                                      |

    | sa         | Saudi Arabia                                               |

    | sn         | Senegal                                                    |

    | rs         | Serbia                                                     |

    | sc         | Seychelles                                                 |

    | sl         | Sierra Leone                                               |

    | sg         | Singapore                                                  |

    | sx         | Sint Maarten (Dutch part)                                  |

    | sk         | Slovakia                                                   |

    | si         | Slovenia                                                   |

    | sb         | Solomon Islands                                            |

    | so         | Somalia                                                    |

    | za         | South Africa                                               |

    | gs         | South Georgia and the South Sandwich Islands               |

    | ss         | South Sudan                                                |

    | es         | Spain                                                      |

    | lk         | Sri Lanka                                                  |

    | sd         | Sudan (the)                                                |

    | sr         | Suriname                                                   |

    | sj         | Svalbard and Jan Mayen                                     |

    | se         | Sweden                                                     |

    | ch         | Switzerland                                                |

    | sy         | Syrian Arab Republic                                       |

    | tw         | Taiwan (Province of China)                                 |

    | tj         | Tajikistan                                                 |

    | tz         | Tanzania, United Republic of                               |

    | th         | Thailand                                                   |

    | tl         | Timor-Leste                                                |

    | tg         | Togo                                                       |

    | tk         | Tokelau                                                    |

    | to         | Tonga                                                      |

    | tt         | Trinidad and Tobago                                        |

    | tn         | Tunisia                                                    |

    | tr         | Turkey                                                     |

    | tm         | Turkmenistan                                               |

    | tc         | Turks and Caicos Islands (the)                             |

    | tv         | Tuvalu                                                     |

    | ug         | Uganda                                                     |

    | ua         | Ukraine                                                    |

    | ae         | United Arab Emirates (the)                                 |

    | gb         | United Kingdom of Great Britain and Northern Ireland (the) |

    | um         | United States Minor Outlying Islands (the)                 |

    | us         | United States of America (the)                             |

    | uy         | Uruguay                                                    |

    | uz         | Uzbekistan                                                 |

    | vu         | Vanuatu                                                    |

    | ve         | Venezuela (Bolivarian Republic of)                         |

    | vn         | Viet Nam                                                   |

    | vg         | Virgin Islands (British)                                   |

    | vi         | Virgin Islands (U.S.)                                      |

    | wf         | Wallis and Futuna                                          |

    | eh         | Western Sahara                                             |

    | ye         | Yemen                                                      |

    | zm         | Zambia                                                     |

    | zw         | Zimbabwe                                                   |

    | ax         | Åland Islands                                              |'
  license:
    name: MIT
  title: Sms portable api
  version: 0.0.0
openapi: 3.0.0
paths:
  /api/get_msisdn_info:
    post:
      description: Identifikace jednoho telefonního čísla
      requestBody:
        content:
          application/json:
            schema:
              properties:
                auth:
                  description: Přihlášení
                  properties:
                    password:
                      description: Přihlašovací klíč uživatele
                      type: string
                    username:
                      description: Identifikace uživatele
                      type: string
                  required:
                  - username
                  - password
                  type: object
                msisdn:
                  description: Telefonní číslo s mezinárodním formátu např. 420123456789
                  type: integer
              required:
              - auth
              - msisdn
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  country:
                    description: Kód země - 2 znaky - ISO Alha2 nebo null
                    type: string
                  msisdn:
                    description: Telefonní číslo s mezinárodním formátu např. 420123456789
                    type: integer
                  provider:
                    description: Identifikace operátora nebo null
                    enum:
                    - o2_cz
                    - tm_cz
                    - vf_cz
                    - nt_cz
                    - fix_cz
                    - tm_sk
                    - or_sk
                    - o2_sk
                    - sw_sk
                    - null
                    nullable: true
                    type: string
                required:
                - msisdn
                type: object
          description: OK
        '403':
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    description:
                      description: Error description
                      example: Not Authorized
                      type: string
                    name:
                      description: Error internal name
                      example: NotAuthorized
                      type: string
                    status:
                      description: Internal number code
                      example: 403
                      type: number
                  required:
                  - status
                  - description
                  - name
                  type: object
          description: Error
        '429':
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    description:
                      description: Error description
                      example: Překročen limit požadavků za minutu
                      type: string
                    name:
                      description: Error internal name
                      example: RequestLimitPerMinuteReached
                      type: string
                    status:
                      description: Internal number code
                      example: 403
                      type: number
                  required:
                  - status
                  - description
                  - name
                  type: object
          description: Error
      summary: Identifikace jednoho telefonního čísla
  /api/get_msisdns_info:
    post:
      description: Identifikace více telefonních čísel, max=50
      requestBody:
        content:
          application/json:
            schema:
              properties:
                auth:
                  description: Přihlášení
                  properties:
                    password:
                      description: Přihlašovací klíč uživatele
                      type: string
                    username:
                      description: Identifikace uživatele
                      type: string
                  required:
                  - username
                  - password
                  type: object
                msisdns:
                  description: Seznam telefonních čísel k identifikaci
                  items:
                    description: Telefonní číslo s mezinárodním formátu např. 420123456789
                    type: integer
                  type: array
              required:
              - auth
              - msisdns
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                description: Seznam identifikovaných telefonních čísel
                items:
                  properties:
                    country:
                      description: Kód země - 2 znaky - ISO Alha2 nebo null
                      type: string
                    msisdn:
                      description: Telefonní číslo s mezinárodním formátu např. 420123456789
                      type: integer
                    provider:
                      description: Identifikace operátora nebo null
                      enum:
                      - o2_cz
                      - tm_cz
                      - vf_cz
                      - nt_cz
                      - fix_cz
                      - tm_sk
                      - or_sk
                      - o2_sk
                      - sw_sk
                      - null
                      nullable: true
                      type: string
                  required:
                  - msisdn
                  type: object
                type: array
          description: OK
        '403':
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    description:
                      description: Error description
                      example: Not Authorized
                      type: string
                    name:
                      description: Error internal name
                      example: NotAuthorized
                      type: string
                    status:
                      description: Internal number code
                      example: 403
                      type: number
                  required:
                  - status
                  - description
                  - name
                  type: object
          description: Error
        '429':
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    description:
                      description: Error description
                      example: Překročen maximální povolený limit
                      type: string
                    name:
                      description: Error internal name
                      example: MaxMsisdnsLimitReached
                      type: string
                    status:
                      description: Internal number code
                      example: 401
                      type: number
                  required:
                  - status
                  - description
                  - name
                  type: object
                - properties:
                    description:
                      description: Error description
                      example: Překročen limit požadavků za minutu
                      type: string
                    name:
                      description: Error internal name
                      example: RequestLimitPerMinuteReached
                      type: string
                    status:
                      description: Internal number code
                      example: 403
                      type: number
                  required:
                  - status
                  - description
                  - name
                  type: object
          description: Error
      summary: Identifikace více telefonních čísel, max=50
  /api/test:
    post:
      description: Testuje dostupnost rozhraní
      requestBody:
        content:
          application/json:
            schema:
              properties:
                auth:
                  description: Přihlášení
                  properties:
                    password:
                      description: Přihlašovací klíč uživatele
                      type: string
                    username:
                      description: Identifikace uživatele
                      type: string
                  required:
                  - username
                  - password
                  type: object
              required:
              - auth
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                description: 'true'
                type: boolean
          description: OK
        '403':
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    description:
                      description: Error description
                      example: Not Authorized
                      type: string
                    name:
                      description: Error internal name
                      example: NotAuthorized
                      type: string
                    status:
                      description: Internal number code
                      example: 403
                      type: number
                  required:
                  - status
                  - description
                  - name
                  type: object
          description: Error
      summary: Testuje dostupnost rozhraní
servers:
- description: Api url
  url: https://sms-portable.atspraha.cz
