@datafire/wavecell

DataFire integration for Wavecell.Sms.Api

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@datafire/wavecell
133317.0.03 years ago7 years agoMinified + 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

  • input object
subAccountId required string body BulkSmsRequest

Output

SendManyMessagesInCompactForm

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

Input

  • input object
subAccountId required string body BulkSmsRequestCompact

Output

SendSingleMessage

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

Input

  • input object
subAccountId required string body SmsRequest

Output

Definitions

BulkSmsRequest

  • BulkSmsRequest object
clientBatchId string includeMessagesInResponse boolean messages required array
* items [SmsRequest](#smsrequest)
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
* items [SmsResponse](#smsresponse)
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