LoopMessage New gen API update; #20459
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| import app from "../../loopmessage.app.mjs"; | ||
|
|
||
| export default { | ||
| key: "loopmessage-check-message-status", | ||
| name: "Check Message Status", | ||
| description: "Action to get the current outbound message status. Possible values: processing, failed, delivered.", | ||
| type: "action", | ||
| version: "0.0.4", | ||
| annotations: { | ||
| destructiveHint: false, | ||
| openWorldHint: true, | ||
| readOnlyHint: true, | ||
| }, | ||
| props: { | ||
| app, | ||
| messageId: { | ||
| type: "string", | ||
| label: "Message ID", | ||
| description: "Outbound message ID.", | ||
| }, | ||
|
Collaborator
There was a problem hiding this comment. Props should display a list of async options if possible. Could the message history endpoint be used to retrieve message IDs?
Contributor
Author
There was a problem hiding this comment. We plan to add it in a future update. |
||
| }, | ||
| methods: { | ||
| getSummary(response) { | ||
| return `Message status: ${response.status ?? "unknown"}`; | ||
| }, | ||
| }, | ||
| async run({ $: step }) { | ||
| try { | ||
| const response = await this.app.getMessageStatus(this.messageId, { | ||
| step, | ||
| }); | ||
| step.export("$summary", this.getSummary(response)); | ||
|
|
||
| return response; | ||
| } catch (error) { | ||
| if (error.response?.status === 400) { | ||
| const message = | ||
| error.response.data?.message ?? | ||
| error.response.data?.error_code ?? | ||
| JSON.stringify(error.response.data); | ||
|
|
||
| throw new Error(message); | ||
| } | ||
| throw error; | ||
| } | ||
| }, | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,42 +1,107 @@ | ||
| import app from "../../loopmessage.app.mjs"; | ||
| import utils from "../../common/utils.mjs"; | ||
|
|
||
| export default { | ||
| key: "loopmessage-send-text-message", | ||
| name: "Send Outbound Message", | ||
| description: "Action to send a message to an individual recipient.", | ||
| type: "action", | ||
| version: "0.0.4", | ||
| annotations: { | ||
| destructiveHint: false, | ||
| openWorldHint: true, | ||
| readOnlyHint: false, | ||
| }, | ||
| props: { | ||
| app, | ||
| contact: { | ||
| propDefinition: [ | ||
| app, | ||
| "contact", | ||
| ], | ||
| }, | ||
| text: { | ||
| propDefinition: [ | ||
| app, | ||
| "text", | ||
| ], | ||
| }, | ||
| subject: { | ||
| propDefinition: [ | ||
| app, | ||
| "subject", | ||
| ], | ||
| }, | ||
| effect: { | ||
| propDefinition: [ | ||
| app, | ||
| "effect", | ||
| ], | ||
| }, | ||
| sender: { | ||
| optional: true, | ||
| propDefinition: [ | ||
| app, | ||
| "sender", | ||
| ], | ||
| }, | ||
| attachments: { | ||
| type: "string[]", | ||
| label: "Attachments", | ||
| description: "Optional. An array of strings. The string must be a full URL of your image. URL should start with https://. HTTP links (without SSL) are not supported. This must be a publicly accessible file URL: we will not be able to reach any URLs that are hidden or that require authentication.", | ||
| optional: true, | ||
| }, | ||
|
michelle0927 marked this conversation as resolved.
|
||
| replyToId: { | ||
| optional: true, | ||
| propDefinition: [ | ||
| app, | ||
| "replyToId", | ||
| ], | ||
| }, | ||
| channel: { | ||
| optional: true, | ||
| propDefinition: [ | ||
| app, | ||
| "channel", | ||
| ], | ||
| }, | ||
| passthrough: { | ||
| optional: true, | ||
| propDefinition: [ | ||
| app, | ||
| "passthrough", | ||
| ], | ||
| }, | ||
| }, | ||
| methods: { | ||
| getSummary(response) { | ||
| return `Request accepted. Message ID: \`${response.message_id}\``; | ||
| }, | ||
| }, | ||
| async run({ $: step }) { | ||
| const { | ||
| app, | ||
| ...data | ||
| } = this; | ||
|
|
||
| try { | ||
| const response = await app.sendMessage({ | ||
| step, | ||
| data: utils.keysToSnakeCase(data), | ||
| }); | ||
| step.export("$summary", this.getSummary(response)); | ||
|
|
||
| return response; | ||
| } catch (error) { | ||
| if (error.response?.status === 400) { | ||
| const message = | ||
| error.response.data?.message ?? | ||
| error.response.data?.error_code ?? | ||
| JSON.stringify(error.response.data); | ||
|
|
||
| throw new Error(message); | ||
| } | ||
| throw error; | ||
| } | ||
| }, | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| import app from "../../loopmessage.app.mjs"; | ||
| import utils from "../../common/utils.mjs"; | ||
|
|
||
| export default { | ||
| key: "loopmessage-send-voice-message", | ||
| name: "Send Outbound Voice Message", | ||
| description: "Send a voice memo. Supports only in: iMessage, RCS, WhatsApp.", | ||
| type: "action", | ||
| version: "0.0.1", | ||
| annotations: { | ||
| destructiveHint: false, | ||
| openWorldHint: true, | ||
| readOnlyHint: false, | ||
| }, | ||
| props: { | ||
| app, | ||
| contact: { | ||
| propDefinition: [ | ||
| app, | ||
| "contact", | ||
| ], | ||
| }, | ||
| sender: { | ||
| optional: true, | ||
| propDefinition: [ | ||
| app, | ||
| "sender", | ||
| ], | ||
| }, | ||
| mediaUrl: { | ||
| propDefinition: [ | ||
| app, | ||
| "mediaUrl", | ||
| ], | ||
| }, | ||
| passthrough: { | ||
| optional: true, | ||
| propDefinition: [ | ||
| app, | ||
| "passthrough", | ||
| ], | ||
| }, | ||
| }, | ||
| methods: { | ||
| getSummary(response) { | ||
| return `Request accepted. Message ID: \`${response.message_id}\``; | ||
| }, | ||
| }, | ||
| async run({ $: step }) { | ||
| const { | ||
| app, | ||
| ...data | ||
| } = this; | ||
|
|
||
| try { | ||
| const response = await app.sendMessage({ | ||
| step, | ||
| data: utils.keysToSnakeCase(data), | ||
| }); | ||
| step.export("$summary", this.getSummary(response)); | ||
|
|
||
| return response; | ||
| } catch (error) { | ||
| if (error.response?.status === 400) { | ||
| const message = | ||
| error.response.data?.message ?? | ||
| error.response.data?.error_code ?? | ||
| JSON.stringify(error.response.data); | ||
|
|
||
| throw new Error(message); | ||
| } | ||
| throw error; | ||
| } | ||
| }, | ||
| }; |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I missed this earlier. All actions should have doc links to the relevant documentation. Applies to all actions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@michelle0927 The problem is that the documentation URLs may change over time. If we provide a link there and the page is moved, it could confuse users.