Better: Add info about compose to SDK doc and API endpoint. RD-29458 (#…

…245)
ringcentral · May 27, 2024 · 51b57fa · 51b57fa
1 parent d5af48f
commit 51b57fa
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 2 deletions.
diff --git a/docs/sdks/source-sdk/quick-start.md b/docs/sdks/source-sdk/quick-start.md
@@ -380,3 +380,21 @@ We need to confirm the message was received by a response from your Channel SDK.
 ```
 
 Notice the `id` is the `in_reply_to_id` sent to you and you are just mirroring back the message body.
+
+### User Management - Recipients for private messages composition
+
+You can compose private messages from RingCX. For this, you need the recipient to have already been imported. This is the case when you have already received a message from them, but you can also force the import by sending a "users.create" payload like this one:
+
+```json
+{
+    "action": "users.create",
+    "params": {
+      "id": "1235",
+      "firstname": "Darlene",
+      "lastname": "Alderson",
+      "screenname": "Darlene",
+      "puppetizable": false,
+      "created_at": "06/11/2017"
+    }
+}
+```
diff --git a/specs/engage-digital_openapi3.yaml b/specs/engage-digital_openapi3.yaml
@@ -1842,12 +1842,15 @@ paths:
           schema:
             type: string
         - description: >-
-            For a SMS, WhatsApp, or Engage Messaging source.
+            For a SMS, WhatsApp, Channel SDK, or Engage Messaging channel.
             For a WhatsApp message or a SMS,
             the number the message will be sent to.
             It must start with 00 or +, example:
             +33634231224 or 0033634231224. This parameter is mandatory when
             initiating a discussion.
+            For a Channel SDK private content,
+            the foreign_id of the identity to send the message to.
+            The identity must have been imported in ED.
             For an Engage Messaging content,
             the foreign_id of the identity to send the message to.
             The oubound messaging option must be enabled.

diff --git a/specs/engage-digital_postman2.json b/specs/engage-digital_postman2.json
@@ -856,7 +856,7 @@
                     {
                       "key": "to",
                       "value": "\u003cstring\u003e",
-                      "description": "For a SMS, WhatsApp, or Engage Messaging source. For a WhatsApp message or a SMS, the number the message will be sent to. It must start with 00 or +, example: +33634231224 or 0033634231224. This parameter is mandatory when initiating a discussion. For an Engage Messaging content, the foreign_id of the identity to send the message to. The oubound messaging option must be enabled. This parameter is mandatory when initiating a discussion and forbidden when replying to an existing message.",
+                      "description": "For a SMS, WhatsApp, Channel SDK, or Engage Messaging channel. For a WhatsApp message or a SMS, the number the message will be sent to. It must start with 00 or +, example: +33634231224 or 0033634231224. This parameter is mandatory when initiating a discussion. For a Channel SDK private content, the foreign_id of the identity to send the message to. The identity must have been imported in ED. For an Engage Messaging content, the foreign_id of the identity to send the message to. The oubound messaging option must be enabled. This parameter is mandatory when initiating a discussion and forbidden when replying to an existing message.",
                       "disabled": true
                     },
                     {