@datafire/wavecell

DataFire integration for Wavecell.Sms.Api

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
11821May 10, 2021Nov 22, 2016Minified + gzip package size for @datafire/wavecell in KB

Readme

@datafire/wavecell

Client library for Wavecell.Sms.Api

Installation and Usage

npm install --save @datafire/wavecell
let wavecell = require('@datafire/wavecell').create({
  BearerTokenHeader: ""
});

.then(data => {
  console.log(data);
});

Description

This API allows Wavecell customers to originate request to send SMS messages anywhere in the World. The messages can be send individually or as a bulk request.

Actions

SmsV1StatusGet

wavecell.SmsV1StatusGet(null, context)

Input

This action has no parameters

Output

Output schema unknown

SendManyMessages

wavecell.SendManyMessages({
  "subAccountId": ""
}, context)

Input

Output

SendManyMessagesInCompactForm

wavecell.SendManyMessagesInCompactForm({
  "subAccountId": ""
}, context)

Input

Output

SendSingleMessage

wavecell.SendSingleMessage({
  "subAccountId": ""
}, context)

Input

  • input object

Output

Definitions

BulkSmsRequest

  • BulkSmsRequest object
    • clientBatchId string
    • includeMessagesInResponse boolean
    • messages required array
    • template SmsTemplate

BulkSmsRequestCompact

  • BulkSmsRequestCompact object
    • clientBatchId string
    • destinations required array
      • items string
    • includeMessagesInResponse boolean
    • template required SmsTemplate

BulkSmsResponse

  • BulkSmsResponse object
    • acceptedCount integer
    • batchId string
    • clientBatchId string
    • messages array
    • rejectedCount integer

ErrorResponse

  • ErrorResponse object
    • code integer
    • errorId string
    • message string
    • timestamp string

SmsRequest

  • SmsRequest object
    • clientMessageId string
    • destination required string
    • encoding string (values: AUTO, GSM7bit, UNICODE)
    • expiry string
    • scheduled string
    • source string
    • text string

SmsResponse

  • SmsResponse object
    • clientMessageId string
    • destination string
    • status SmsStatus
    • umid string

SmsStatus

  • SmsStatus object
    • code string
    • description string

SmsTemplate

  • SmsTemplate object
    • encoding string (values: AUTO, GSM7bit, UNICODE)
    • expiry string
    • scheduled string
    • source string
    • text string

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.