nexmo_api_specification 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e93163de5928d62ee0d7ad6c3bd4eccfcdb94adf
-  data.tar.gz: 78bd4f2bd3a1a99092450278d358fd5def691d85
+  metadata.gz: 4f08afcb55e90cc465af9770fa709e87e1d4f38e
+  data.tar.gz: 6803b535d910888378f236dbce390c422c372ea1
 SHA512:
-  metadata.gz: d6d167234ab3f77ed0d92a93584b4793b9fbfbd2a20db8830751212432781c5d1801299ca4dd73f212844075046728d3fb36c270dd3e592706385f857a27a2a4
-  data.tar.gz: 4463662a65d874cb8a2ecb561c71e6038f10616ffe249345c4465204fa412cac2e65eaad48d0a9acfc133fda879ea1f4a44bdd2098d533f604b72723b2b2d1dc
+  metadata.gz: 2e77fb4eb4c6f09b853b045bbb15a3ac0ec445f345fb5792af116836beb31d568fce207856ae3d0a0b19e489160d07e72f6d63d1f14000fc3640b7b5c9037d65
+  data.tar.gz: a9f5a99f97a46271bd5f6293aa9088939e576afdb20d49e2f96ff0d6a6660af1b38f7b9c17a51d79f8dbb74ce19d514e62433e8980737acfde0566ca8c77bd35

data/definitions/sms.yml

@@ -81,6 +81,26 @@ paths:
               responses:
                 '200':
                   description: Your server returns this code if it accepts the callback
+x-webhooks:
+  inbound-sms:
+    '{$request.body#/callback}':
+      post:
+        summary: Inbound SMS
+        operationId: inbound-sms
+        x-example-path: '/webhooks/inbound-sms'
+        description: |
+          If you rent one or more virtual numbers from Nexmo, inbound messages to that number are sent to your [webhook endpoint](/concepts/guides/webhooks).
+
+          When you receive an inbound message, you must send a 2xx response. If you do not send a 2xx response Nexmo will resend the inbound message for the next 24 hours.
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/InboundMessage'
+        responses:
+          '200':
+            description: Your server returns this code if it accepts the callback
 
 components:
   schemas:
@@ -114,8 +134,8 @@ components:
         status-report-req:
           description: '**Advanced**: Boolean indicating if you like to receive a [Delivery Receipt](/messaging/sms/building-blocks/receive-a-delivery-receipt).'
           type: boolean
-          example: 'false'
-          default: 'true'
+          example: false
+          default: true
         callback:
           description: '**Advanced**: The webhook endpoint the delivery receipt for this sms is sent to. This parameter overrides the webhook endpoint you set in Dashboard.'
           type: string
@@ -209,6 +229,80 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/Message'
+    InboundMessage:
+      type: object
+      properties:
+        msisdn:
+          type: string
+          description: The phone number that this inbound message was sent from.
+          example: '447700900001'
+          required: true
+        to:
+          type: string
+          description: The phone number the message was sent to. **This is your virtual number**.
+          example: '447700900000'
+          required: true
+        messageId:
+          type: string
+          description: The ID of the message
+          example: 0A0000000123ABCD1
+          required: true
+        text:
+          type: string
+          description: The message body for this inbound message.
+          example: Hello world
+          required: true
+        type:
+          type: string
+          description: |
+            Possible values are:
+
+              - `text` - standard text.
+              - `unicode` - URLencoded   unicode  . This is valid for standard GSM, Arabic, Chinese, double-encoded characters and so on.
+              - `binary` - a binary message.
+          example: 'text'
+          required: true
+        keyword:
+          type: string
+          description: The first word in the message body. This is typically used with short codes.
+          example: Hello
+          required: true
+        message-timestamp:
+          description: The time when Nexmo started to push this Delivery Receipt to your webhook endpoint.
+          type: string
+          example: 2020-01-01 12:00:00
+          required: true
+        timestamp:
+          description: A unix timestamp representation of message-timestamp.
+          type: string
+          example: "1578787200"
+        nonce:
+          type: string
+          description: A random string that forms part of the signed set of parameters, it adds an extra element of unpredictability into the signature for the request. You use the nonce and timestamp parameters with your shared secret to calculate and validate the signature for inbound messages.
+          example: aaaaaaaa-bbbb-cccc-dddd-0123456789ab
+        concat:
+          type: string
+          description: True - if this is a concatenated message.
+          example: 'true'
+        concat-ref:
+          type: string
+          description: The transaction reference. All parts of this message share this value.
+          example: '1'
+        concat-total:
+          type: string
+          description: The number of parts in this concatenated message.
+          example: '3'
+        concat-part:
+          type: string
+          description: The number of this part in the message. Counting starts at 1.
+          example: '2'
+        data:
+          type: string
+          format: binary
+          description: The content of this message, if type is binary.
+        udh:
+          type: string
+          description: The hex encoded User Data Header, if type is binary
     Message:
       type: object
       properties:

data/lib/nexmo_api_specification/version.rb

@@ -1,3 +1,3 @@
 module NexmoApiSpecification
-  VERSION = '0.5.4'.freeze
+  VERSION = '0.6.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo_api_specification
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Adam Butler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-05 00:00:00.000000000 Z
+date: 2018-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler