nexmo_api_specification 0.2.0 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/nexmo_api_specification/version.rb +1 -1
- data/sms.yml +61 -0
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e3a3d2edc15c4a3f0d4b90b4eec19dde5a1c6d63
|
|
4
|
+
data.tar.gz: d287844c1833b6ee298c64abc6d0b28299c7011f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 84e009df00b76232f042911c5f3cf8bf04b4bf5c391b00cf6cb0436188d6aa9f6d65b1f9ae9374aa87da946443fcd0f42778a37849c796ea2d0e365c8e3c3d9a
|
|
7
|
+
data.tar.gz: df6fb2cac210383812d9634fc6b051c2a7b03ab2fb8e56f1e2aab32bfb447aaff28447ce7866fd21ac4d86c39662b4b2cf1eedc8cee2cf344bb7f5a340cc9721
|
data/sms.yml
CHANGED
|
@@ -63,6 +63,22 @@ paths:
|
|
|
63
63
|
application/json:
|
|
64
64
|
schema:
|
|
65
65
|
$ref: '#/components/schemas/Message'
|
|
66
|
+
callbacks:
|
|
67
|
+
delivery-receipt:
|
|
68
|
+
'{$request.body#/callback}':
|
|
69
|
+
post:
|
|
70
|
+
summary: Delivery Receipt
|
|
71
|
+
description: The following are parameters sent in as a [delivery receipt](/messaging/sms/guides/delivery-receipts) callback. You can subscribe to [webhooks](/concepts/guides/webhooks) to receive notification when the delivery status of an SMS that you have sent with Nexmo changes.
|
|
72
|
+
requestBody:
|
|
73
|
+
required: true
|
|
74
|
+
content:
|
|
75
|
+
application/json:
|
|
76
|
+
schema:
|
|
77
|
+
$ref: '#/components/schemas/DeliveryReceipt'
|
|
78
|
+
responses:
|
|
79
|
+
'200':
|
|
80
|
+
description: Your server returns this code if it accepts the callback
|
|
81
|
+
|
|
66
82
|
components:
|
|
67
83
|
schemas:
|
|
68
84
|
NewMessage:
|
|
@@ -213,6 +229,51 @@ components:
|
|
|
213
229
|
type: string
|
|
214
230
|
description: The ID of the network of the recipient
|
|
215
231
|
example: '12345'
|
|
232
|
+
DeliveryReceipt:
|
|
233
|
+
type: object
|
|
234
|
+
properties:
|
|
235
|
+
msisdn:
|
|
236
|
+
type: string
|
|
237
|
+
description: The number the message was sent to
|
|
238
|
+
example: '447700900000'
|
|
239
|
+
to:
|
|
240
|
+
type: string
|
|
241
|
+
description: The SenderID you set in from in your request
|
|
242
|
+
example: Acme Inc
|
|
243
|
+
network-code:
|
|
244
|
+
type: string
|
|
245
|
+
description: The Mobile Country Code Mobile Network Code (MCCMNC) of the carrier this phone number is registered with.
|
|
246
|
+
example: '12345'
|
|
247
|
+
messageId:
|
|
248
|
+
type: string
|
|
249
|
+
description: The Nexmo ID for this message.
|
|
250
|
+
example: '0A0000001234567B'
|
|
251
|
+
price:
|
|
252
|
+
type: string
|
|
253
|
+
description: The cost of the message
|
|
254
|
+
example: '0.03330000'
|
|
255
|
+
status:
|
|
256
|
+
type: string
|
|
257
|
+
description: A code that explains where the message is in the delivery process.
|
|
258
|
+
example: 'delivered'
|
|
259
|
+
x-possible-values:
|
|
260
|
+
- delivered
|
|
261
|
+
- expired
|
|
262
|
+
- failed
|
|
263
|
+
- rejected
|
|
264
|
+
- accepted
|
|
265
|
+
- buffered
|
|
266
|
+
- unknown
|
|
267
|
+
scts:
|
|
268
|
+
type: string
|
|
269
|
+
description: When the DLR was recieved from the carrier in the following format `YYMMDDHHMM`. For example, `2001011400` is at `2020-01-01 14:00`
|
|
270
|
+
example: 2001011400
|
|
271
|
+
err-code:
|
|
272
|
+
type: string
|
|
273
|
+
message-timestamp:
|
|
274
|
+
description: The time when Nexmo started to push this Delivery Receipt to your webhook endpoint.
|
|
275
|
+
type: string
|
|
276
|
+
example: 2020-01-01 12:00:00
|
|
216
277
|
x-groups:
|
|
217
278
|
sms:
|
|
218
279
|
name: "SMS"
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: nexmo_api_specification
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.3.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Adam Butler
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2017-
|
|
11
|
+
date: 2017-12-01 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: bundler
|
|
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
93
93
|
version: '0'
|
|
94
94
|
requirements: []
|
|
95
95
|
rubyforge_project:
|
|
96
|
-
rubygems_version: 2.6.
|
|
96
|
+
rubygems_version: 2.6.11
|
|
97
97
|
signing_key:
|
|
98
98
|
specification_version: 4
|
|
99
99
|
summary: Provides Open API Spec 3 definitions for Nexmo APIs
|