Superface

Send Message

communication/send-message@2.0.1
1 provider

Send Message

Sends message to one destination

Input
Destination
Text
Result
Destination
Message ID

1.Choose a provider

2.Use SendMessage with mock in your code

Below instructions are for our Node.js SDK. Use OneService for other languages.
npm i @superfaceai/one-sdk
const { SuperfaceClient } = require('@superfaceai/one-sdk');

// You can manage tokens here: https://superface.ai/insights
const sdk = new SuperfaceClient({ sdkAuthToken: '<< Login to get your token >>' });

async function run() {
  // Load the profile
  const profile = await sdk.getProfile('communication/send-message@2.0.1');

  // Use the profile
  const result = await profile
    .getUseCase('SendMessage')
    .perform({
      destination: 'C1H9RESGL',
      text: 'Our app has 1,000,000 subscribers!'
    }, {
      provider: 'mock'
    });

  // Handle the result
  try {
    const data = result.unwrap();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

run();

Structure details

Input (object)

destination
Representation of a messaging destination. Can be ID or channel name, depending on the provider capability.
text
Text of the message

Example

{
  "destination": "C1H9RESGL",
  "text": "Our app has 1,000,000 subscribers!"
}

Result (object)

destination
Identifier of the destination where the message was sent.
messageId
Identifier of the message that was sent

Example

{
  "destination": "C1H9RESGL",
  "messageId": "1503435956.000247"
}

Implementation details

Provider
mock
Use case
SendMessage
Author
@superface
Source
Verified