-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCarrier_Pricing_API_example.yaml
171 lines (166 loc) · 4.17 KB
/
Carrier_Pricing_API_example.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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
openapi: 3.0.0
info:
title: Carrier Wholesale Pricing API
description: Provides real-time access and updates to wholesale pricing for voice, SMS, and virtual numbers among carrier partners.
version: "1.0.0"
servers:
- url: 'https://api.yourcompany.com/v1'
paths:
/voicePricing:
get:
summary: Retrieve voice pricing information
operationId: getVoicePricing
tags:
- Voice Pricing
responses:
'200':
description: A list of voice pricing information
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/VoicePricing'
post:
summary: Update voice pricing information
operationId: updateVoicePricing
tags:
- Voice Pricing
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VoicePricing'
responses:
'200':
description: Voice pricing information updated successfully
/smsPricing:
get:
summary: Retrieve SMS pricing information
operationId: getSmsPricing
tags:
- SMS Pricing
responses:
'200':
description: A list of SMS pricing information
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SmsPricing'
post:
summary: Update SMS pricing information
operationId: updateSmsPricing
tags:
- SMS Pricing
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SmsPricing'
responses:
'200':
description: SMS pricing information updated successfully
/virtualNumbers:
get:
summary: Retrieve virtual numbers pricing information
operationId: getVirtualNumbersPricing
tags:
- Virtual Numbers Pricing
responses:
'200':
description: A list of virtual numbers pricing information
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/VirtualNumbersPricing'
post:
summary: Update virtual numbers pricing information
operationId: updateVirtualNumbersPricing
tags:
- Virtual Numbers Pricing
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VirtualNumbersPricing'
responses:
'200':
description: Virtual numbers pricing information updated successfully
components:
schemas:
VoicePricing:
type: object
properties:
prefixE164:
type: string
price1:
type: number
priceN:
type: number
validFrom:
type: string
timezone:
type: string
interval1:
type: integer
intervalN:
type: integer
forbidden:
type: boolean
discontinued:
type: boolean
SmsPricing:
type: object
properties:
mccmncE212:
type: string
price:
type: number
effectiveFrom:
type: string
forbidden:
type: boolean
discontinued:
type: boolean
VirtualNumbersPricing:
type: object
properties:
numberE164:
type: string
inboundVoicePrice:
type: number
inboundSmsPrice:
type: number
interval:
type: integer
mrc:
type: number
nrc:
type: number
documentsVerificationRequired:
type: boolean
status:
type: integer
type:
type: string
voice:
type: boolean
sms:
type: boolean
fax:
type: boolean
video:
type: boolean
capacity:
type: integer
notes:
type: string
localRequirements:
type: integer