-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
148 lines (148 loc) · 4.25 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
openapi: 3.0.0
info:
title: Telintel Mobile Number Portability
description: >-
The following document describes the procedure to use the Telintel
Portability HTTPS service. Description and requirements. This service is
intended for live traffic, it is scoped for SMS notification systems as well
as extend func. It uses queries through the HTTP protocol. It is intended to
cover the features expected in standard REST service. The Port Orders
instance resource represents a single port request comprising the phone
number that the customer wishes to port to.
version: 1.0.0
contact:
name: Telintel
url: https://telintel.com/
x-konfig-ignore:
potential-incorrect-type: true
servers:
- description: Telintel Portability Server
url: http://hlr.telintel.net:3080/HlrWebService/Hlr2
tags:
- name: Request
paths:
/HlrService:
get:
tags:
- Request
summary: HTTP Query Procedure
operationId: Request_hlrServiceDetails
description: >-
The server and port numbers for the HLR/HTTP service along with your
username and password will be provided to you by your sales manager.
parameters:
- in: query
name: login
required: true
schema:
type: string
example: username
- in: query
name: pass
required: true
schema:
type: string
example: password
- in: query
name: number
required: true
schema:
type: integer
example: 573005555555
responses:
'200':
description: Succesfull request
content:
application/json:
schema:
$ref: '#/components/schemas/RequestHlrServiceDetailsResponse'
components:
schemas:
request:
type: object
properties:
username:
description: As login, authentication parameter
type: string
password:
description: User password
type: string
phoneNumber:
description: Phone number to look up
type: integer
response:
type: object
properties:
succeded:
description: >-
Returns true when the request has been processed. Otherwise false is
returned. The transaction details will extend the status accordingly
type: boolean
country:
description: Country information for the subscribed phone number
type: string
submittedNumber:
description: (country_code+phone_number) in long format
type: string
mcc:
description: Mobile Country Code
type: string
mnc:
description: Mobile Network Code
type: string
isPorted:
description: Mobile Country Code
type: boolean
originalNetwork:
description: Original operator for the queried number
type: string
portedNetwork:
description: Current operator for the queried number
type: string
transactionDetails:
description: Returns Ok when the queried number is valid or an error statement
type: string
portedMnc:
description: Ported Mobile Network Code
type: string
spid:
description: Spid number
type: string
RequestHlrServiceDetailsResponse:
type: object
properties:
succeded:
type: boolean
example: true
country:
type: string
example: Country Name
submittedNumber:
type: string
example: PhoneNumber
mcc:
type: string
example: '123'
mnc:
type: string
example:
- '321'
isPorted:
type: boolean
example: true
originalNetwork:
type: string
example: Original Network Name
portedNetwork:
type: string
example: Ported Network Name
transactionDetails:
type: string
example: ok
portedMnc:
type: string
example:
- '124'
spid:
type: string
example: 12345!